Skip to content

Commit 2e0c166

Browse files
author
Tim Kutcher
committed
Add sphinx docs information to contributing.md (#41)
1 parent 2ee0540 commit 2e0c166

1 file changed

Lines changed: 7 additions & 1 deletion

File tree

CONTRIBUTING.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,5 +21,11 @@ reference the relevant GitHub Issue(s) via `(#ID)`
2121

2222
### Updating Dependencies
2323
- Use the poetry commands for adding and updating dependencies.
24-
- For sphinx to get the requirements.txt you must run
24+
- For general dependency updates it is `poetry update`
25+
- For sphinx to get the new requirements.txt you must run
2526
`poetry export -f requirements.txt --output docs/requirements.txt --without-hashes --dev`
27+
28+
### Building Documentation
29+
- To build the documentation locally you can run `poetry run make html`
30+
- Then you can inspect what the readthedocs documentation will look like by opening
31+
docs/build/html/index.html

0 commit comments

Comments
 (0)