Skip to content

Commit 67cefe1

Browse files
committed
chore: added documentation to CONTRIBUTING guidelines
Signed-off-by: Paul Horton <[email protected]>
1 parent aa37e56 commit 67cefe1

File tree

1 file changed

+17
-0
lines changed

1 file changed

+17
-0
lines changed

CONTRIBUTING.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,20 @@ poetry run isort .
2626
poetry run autopep8 --in-place -r .
2727
```
2828

29+
## Documentation
30+
31+
This project uses [Sphinx] to generate documentation which is automatically published to [readthedocs.io].
32+
33+
Source for documentation is stored in the `docs` folder in [RST] format.
34+
35+
You can generate the documentation locally by running:
36+
37+
```shell
38+
cd docs
39+
pip install -r requirements.txt
40+
make html
41+
```
42+
2943
## Testing
3044

3145
Run all tests in dedicated environments, via:
@@ -45,3 +59,6 @@ git commit --signed-off ...
4559

4660
[poetry]: https://python-poetry.org
4761
[PEP8]: https://www.python.org/dev/peps/pep-0008
62+
[Sphinx]: https://www.sphinx-doc.org/
63+
[readthedocs.io]: https://cyclonedx-python-library.readthedocs.io/
64+
[RST]: https://en.wikipedia.org/wiki/ReStructuredText

0 commit comments

Comments
 (0)