Skip to content

Commit c8b90e7

Browse files
Add local install instructions
1 parent f144173 commit c8b90e7

File tree

1 file changed

+18
-2
lines changed

1 file changed

+18
-2
lines changed

README.md

Lines changed: 18 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,30 @@ This repository contains our internal documentation for Specify Collections Cons
44

55
This site uses [Sphinx](https://www.sphinx-doc.org/en/master/) as a framework and is built using `github-pages`. You can view the [deployment history here](https://github.com/specify/specify.github.io/deployments/github-pages).
66

7-
8-
97
## Contribution Guidelines
108
- Do **not commit** sensitive information. This is a public repository.
119
- Docs that are useful or relevant to users of Specify should instead be pushed to the [**Speciforum**](discourse.specifysoftware.org), not this repository.
1210
- Docs added to this repository should be removed from their original location (e.g. Google Drive, ResFS, OneDrive, etc.) after it is committed.
1311
- Be kind, considerate, and thoughtful.
1412

13+
## Run Locally
14+
15+
To run Sphinx locally, you need to create a Python3 virtual environment, install the requirements, and run `make html`. See below:
16+
17+
```bash
18+
python3 -m venv venv
19+
source venv/bin/activate
20+
pip install -r requirements-docs.txt
21+
cd sphinx
22+
make html
23+
```
24+
25+
Each time you make a change, you'll need to run `make html` again from the `sphinx` directory. You should see a list of warnings in the terminal each time to indicate potential issues in the repository. See below:
26+
27+
```bash
28+
checking consistency... /Users/g584f396/GitHub/specify.github.io/sphinx/aws/aws_authentication.rst: WARNING: document isn't included in any toctree [toc.not_included]
29+
```
30+
1531
## Contribute
1632
1733
Contribution for this repository is limited only to SCC staff.

0 commit comments

Comments
 (0)