Elgato_dark/python-tuf
1
0
Fork 0
mirror of https://github.com/theupdateframework/python-tuf synced 2026-05-24 10:08:28 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
python-tuf/docs/api/tuf.api.rst

21 lines
344 B
ReStructuredText
Raw Permalink Normal View History

Add sphinx docs source files 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>
2021-08-09 12:23:54 +00:00
Metadata API
===============
Separate API documentation pages This makes the individual pages easier to read. Use some autodoc configuration so we can have less config in the automodule/autoclass declarations. Signed-off-by: Jussi Kukkonen <jkukkonen@vmware.com>
2021-09-23 10:03:28 +00:00
.. toctree::
Add sphinx docs source files 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>
2021-08-09 12:23:54 +00:00
Separate API documentation pages This makes the individual pages easier to read. Use some autodoc configuration so we can have less config in the automodule/autoclass declarations. Signed-off-by: Jussi Kukkonen <jkukkonen@vmware.com>
2021-09-23 10:03:28 +00:00
tuf.api.metadata.metadata
tuf.api.metadata.root
tuf.api.metadata.timestamp
tuf.api.metadata.snapshot
tuf.api.metadata.targets
Add sphinx docs source files 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>
2021-08-09 12:23:54 +00:00
docs: Improve tuf.api docs Write a bit more about the two modules, hide the actual TOC to not repeat (and not have sphinx complain about missing items in TOC) Signed-off-by: Jussi Kukkonen <jkukkonen@vmware.com>
2021-08-23 07:34:02 +00:00
.. toctree::
:hidden:
Add sphinx docs source files 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>
2021-08-09 12:23:54 +00:00
docs: rename "helpers" to "supporting classes" Also add a summary to the page -- unfortunately getting a standard TOC would require creating a rst page for each class. Signed-off-by: Jussi Kukkonen <jkukkonen@vmware.com>
2021-09-23 14:06:17 +00:00
tuf.api.metadata.supporting
docs: Improve tuf.api docs Write a bit more about the two modules, hide the actual TOC to not repeat (and not have sphinx complain about missing items in TOC) Signed-off-by: Jussi Kukkonen <jkukkonen@vmware.com>
2021-08-23 07:34:02 +00:00
tuf.api.serialization
Separate API documentation pages This makes the individual pages easier to read. Use some autodoc configuration so we can have less config in the automodule/autoclass declarations. Signed-off-by: Jussi Kukkonen <jkukkonen@vmware.com>
2021-09-23 10:03:28 +00:00
.. automodule:: tuf.api.metadata
doc: display inherited members on RTD Update sphinx/rtd conf to display inherited members. This is enabled specifically for the newly added `expires` property, which has a useful code snippet in the docstring. We don't display - them on the tuf.api automodule overview page (avoid duplicates) - members inherited from the built-in Exception class Signed-off-by: Lukas Puehringer <lukas.puehringer@nyu.edu>
2021-12-22 10:33:02 +00:00
:no-members:
:no-inherited-members:
Reference in a new issue Copy permalink