python-tuf/docs/index.rst
Jussi Kukkonen 4f71f98008
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-25 17:05:06 +03:00

19 lines
No EOL
599 B
ReStructuredText

TUF Developer Documentation
===========================
This documentation provides essential information for those developing software
with the `Python reference implementation of The Update Framework (TUF)
<https://github.com/theupdateframework/tuf>`_.
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.
.. toctree::
:maxdepth: 1
:caption: Contents:
api/api-reference
CONTRIBUTORS
INSTALLATION