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/index.rst

21 lines
708 B
ReStructuredText
Raw Normal View History

docs: API Reference tweaks * Improve content * Make ngclient Updater __init__() visible in docs * Remove "legacy implementation" (except for the note on API stability) Signed-off-by: Jussi Kukkonen <jkukkonen@vmware.com>
2021-08-19 13:14:57 +00:00
TUF Developer Documentation
===========================
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: API Reference tweaks * Improve content * Make ngclient Updater __init__() visible in docs * Remove "legacy implementation" (except for the note on API stability) Signed-off-by: Jussi Kukkonen <jkukkonen@vmware.com>
2021-08-19 13:14:57 +00:00
This documentation provides essential information for those developing software
with the `Python reference implementation of The Update Framework (TUF)
Update links to account for repository rename We have renamed the repository from tuf->python-tuf Signed-off-by: Joshua Lock <jlock@vmware.com>
2021-09-01 10:14:55 +00:00
<https://github.com/theupdateframework/python-tuf>`_.
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: API Reference tweaks * Improve content * Make ngclient Updater __init__() visible in docs * Remove "legacy implementation" (except for the note on API stability) Signed-off-by: Jussi Kukkonen <jkukkonen@vmware.com>
2021-08-19 13:14:57 +00:00
The reference implementation provides easy-to-use components for Python
developers but also aims to be a readable guide and demonstration for those
working on implementing TUF in their own languages, environments, or update
systems.
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
.. toctree::
docs: API Reference tweaks * Improve content * Make ngclient Updater __init__() visible in docs * Remove "legacy implementation" (except for the note on API stability) Signed-off-by: Jussi Kukkonen <jkukkonen@vmware.com>
2021-08-19 13:14:57 +00:00
:maxdepth: 1
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
:caption: Contents:
doc: Remove trailing whitespaces from docs files This commit is a simple trailing whitespaces cleanup from the files inside the docs folder. The files on docs sub-directories are not part of this commit. The docs/SECURITY.md will be removed on PR #1769 Signed-off-by: Kairo de Araujo <kdearaujo@vmware.com>
2022-01-13 16:55:30 +00:00
docs: Move the sphinx root to docs/ This allows using existing documentation in the published documentation without * moving the existing docs (which would break external links) * tricks like symlinks that create issues with relative links Put the api reference files into a subdirectory to avoid polluting the main docs/ directory. Include "Installation" and "Instructions for Contributors" in the published documentation. Signed-off-by: Jussi Kukkonen <jkukkonen@vmware.com>
2021-08-20 12:52:57 +00:00
api/api-reference
docs: add examples to the RTD This commit adds to the RTD the links references to source code examples. The examples are added to TUF ngclient Updater, Metadata and API reference. includes a seed for examples/README.md Signed-off-by: Kairo de Araujo <kdearaujo@vmware.com>
2022-01-13 16:51:37 +00:00
INSTALLATION
Usage examples <https://github.com/theupdateframework/python-tuf/tree/develop/examples>
doc: minor title changes for rtd navbar Make contributing document header sentence case for consistency with other docs and shorten menu name in side navbar to stand out less. Signed-off-by: Lukas Puehringer <lukas.puehringer@nyu.edu>
2022-02-09 16:47:12 +00:00
Contribute <CONTRIBUTING>
Reference in a new issue Copy permalink