mirror of
https://github.com/theupdateframework/python-tuf
synced 2026-05-24 10:08:28 +00:00
e32beb5845
Add .rst source files for building documentation with 'sphinx'. The two mandatory files are conf.py containing the build configuration and the master doc file index.rst. Sphinx uses 'autodoc' to automatically include docstrings. 'autodoc' imports the modules and needs TUF installed in the environment. The following command will generate the documentation from the source files in an html format: `sphinx-build -b html docs/sphinx/source docs/sphinx/build/html` Signed-off-by: Teodora Sechkova <tsechkova@vmware.com> |
||
|---|---|---|
| .. | ||
| adr | ||
| images | ||
| latex | ||
| sphinx/source | ||
| AUTHORS.txt | ||
| CHANGELOG.md | ||
| CLI.md | ||
| CODE-OF-CONDUCT.md | ||
| CONTRIBUTORS.rst | ||
| GETTING_STARTED.rst | ||
| GOVERNANCE.md | ||
| INSTALLATION.rst | ||
| MAINTAINERS.txt | ||
| METADATA.md | ||
| OVERVIEW.rst | ||
| QUICKSTART.md | ||
| RELEASE.md | ||
| ROADMAP.md | ||
| SECURITY.md | ||
| TAP.rst | ||
| tuf-spec.0.9.txt | ||
| tuf-spec.md | ||
| tuf-spec.txt | ||
| TUTORIAL.md | ||