Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Automate Signer API docs for RTD #622

Merged
merged 3 commits into from
Sep 1, 2023
Merged

Automate Signer API docs for RTD #622

merged 3 commits into from
Sep 1, 2023

Commits on Aug 21, 2023

  1. docs: add sphinx and rtd boilerplate 

    - add basic docs landing page (index.rst)
- copy and adapt docs config from python-tuf (docs/conf.py)
- add sphinx make files generated with sphinx-quickstart
- add docs- and include in dev- reqirements.txt
- gitignore sphinx build directory
- add rtd config file

Signed-off-by: Lukas Puehringer <lukas.puehringer@nyu.edu>
    @lukpueh
    lukpueh committed Aug 21, 2023
    Configuration menu
    Copy the full SHA
    72b5d4b View commit details
    Browse the repository at this point in the history

  2. doc: make Signer docstrings sphinx-friendly 

    - re-format Signer and Key docstrings
- add autodoc docstrings for public dispatch tables
- add args docstrings for Signature

Signed-off-by: Lukas Puehringer <lukas.puehringer@nyu.edu>
    @lukpueh
    lukpueh committed Aug 21, 2023
    Configuration menu
    Copy the full SHA
    fff0a81 View commit details
    Browse the repository at this point in the history

  3. doc: add basic Signer API overview to RTD docs 

    Signed-off-by: Lukas Puehringer <lukas.puehringer@nyu.edu>
    @lukpueh
    lukpueh committed Aug 21, 2023
    Configuration menu
    Copy the full SHA
    0989edd View commit details
    Browse the repository at this point in the history