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 2
python-tuf/docs/api/tuf.api.rst

19 lines
572 B
ReStructuredText
Raw 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
===============
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
The low-level Metadata API contains two modules:
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 formating Remove/add new lines at the end of file. Signed-off-by: Teodora Sechkova <tsechkova@vmware.com>
2021-08-25 14:00:05 +00:00
* :doc:`tuf.api.metadata` contains the actual Metadata abstraction
that higher level libraries and application code should use to interact
with TUF metadata. This abstraction provides safe reading and writing to
supported file formats and helper functions for accessing and modifying
the metadata contents.
* :doc:`tuf.api.serialization` covers serializing the metadata into
specific wire formats (like json).
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: 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.metadata
tuf.api.serialization
Reference in a new issue Copy permalink