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
6674 commits 28 branches 35 tags 23 MiB
Commit graph

7 commits

Author SHA1 Message Date
Jussi Kukkonen
b690d8f573 docs: Include version number in docs 
Otherwise on readthedocs it's not clear what version "latest" is.

Signed-off-by: Jussi Kukkonen <jkukkonen@google.com>
 2025-03-14 15:00:33 +02:00
Lukas Puehringer
0b2b1bbe0e 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 17:56:35 +01:00
Lukas Puehringer
4d1fad233a doc: rename contribution instructions 
Rename CONTRIBUTORS.rst -> CONTRIBUTING.rst. The new name is what
GitHub expects and will make the document more discoverable, e.g.
on https://github.com/theupdateframework/python-tuf/contribute.

More details under:
https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/setting-guidelines-for-repository-contributors

Note: I searched all repositories in theupdateframework GitHub
organization for references (there were none) and will update the
links in the CII Best Practice badge app for tuf.

Signed-off-by: Lukas Puehringer <lukas.puehringer@nyu.edu>
 2022-02-09 15:08:45 +01:00
Kairo de Araujo
23534790cd 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-18 13:14:02 +01:00
Kairo de Araujo
e6492112d8 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-14 07:40:17 +01:00
Joshua Lock
3dc5594242 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 11:15:33 +01:00
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
Renamed from docs/sphinx/source/index.rst (Browse further)