File tree Expand file tree Collapse file tree 1 file changed +17
-0
lines changed Expand file tree Collapse file tree 1 file changed +17
-0
lines changed Original file line number Diff line number Diff line change @@ -26,6 +26,20 @@ poetry run isort .
26
26
poetry run autopep8 --in-place -r .
27
27
```
28
28
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
+
29
43
## Testing
30
44
31
45
Run all tests in dedicated environments, via:
@@ -45,3 +59,6 @@ git commit --signed-off ...
45
59
46
60
[ poetry ] : https://python-poetry.org
47
61
[ 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
You can’t perform that action at this time.
0 commit comments