We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
1 parent 2ee0540 commit 2e0c166Copy full SHA for 2e0c166
1 file changed
CONTRIBUTING.md
@@ -21,5 +21,11 @@ reference the relevant GitHub Issue(s) via `(#ID)`
21
22
### Updating Dependencies
23
- Use the poetry commands for adding and updating dependencies.
24
-- For sphinx to get the requirements.txt you must run
+- For general dependency updates it is `poetry update`
25
+- For sphinx to get the new requirements.txt you must run
26
`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