mirror of
https://github.com/theupdateframework/python-tuf
synced 2026-05-24 10:08:28 +00:00
868afda420
Situation before * constructor args are not documented * object attributes are documented * sphinx cannot show object attribute type annotations * attribute docs take a lot of vertical space Now: * constructor args are documented * sphinx can show annotated types of constructor args * class docstring now explains the attributes are the same as constructor args (and attributes are not explicitly documented) Signed-off-by: Jussi Kukkonen <jkukkonen@vmware.com>
65 lines
2.3 KiB
Python
65 lines
2.3 KiB
Python
# Configuration file for the Sphinx documentation builder.
|
|
#
|
|
# This file only contains a selection of the most common options. For a full
|
|
# list see the documentation:
|
|
# https://www.sphinx-doc.org/en/master/usage/configuration.html
|
|
|
|
# -- Path setup --------------------------------------------------------------
|
|
|
|
# If extensions (or modules to document with autodoc) are in another directory,
|
|
# add these directories to sys.path here. If the directory is relative to the
|
|
# documentation root, use os.path.abspath to make it absolute, like shown here.
|
|
#
|
|
import os
|
|
import sys
|
|
sys.path.insert(0, os.path.abspath(os.path.join('..')))
|
|
|
|
import tuf
|
|
|
|
# -- Project information -----------------------------------------------------
|
|
|
|
project = 'TUF'
|
|
copyright = '2021, New York University and the TUF contributors'
|
|
author = 'New York University and the TUF contributors'
|
|
|
|
|
|
# -- General configuration ---------------------------------------------------
|
|
|
|
master_doc = 'index'
|
|
|
|
# Add any Sphinx extension module names here, as strings. They can be
|
|
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
|
|
# ones.
|
|
extensions = ['sphinx.ext.napoleon']
|
|
|
|
# Add any paths that contain templates here, relative to this directory.
|
|
templates_path = ['_templates']
|
|
|
|
# List of patterns, relative to source directory, that match files and
|
|
# directories to ignore when looking for source files.
|
|
# This pattern also affects html_static_path and html_extra_path.
|
|
exclude_patterns = ['GETTING_STARTED.rst', 'OVERVIEW.rst', 'TAP.rst']
|
|
|
|
# -- Options for HTML output -------------------------------------------------
|
|
|
|
# The theme to use for HTML and HTML Help pages. See the documentation for
|
|
# a list of builtin themes.
|
|
#
|
|
html_theme = 'sphinx_rtd_theme'
|
|
|
|
# Add any paths that contain custom static files (such as style sheets) here,
|
|
# relative to this directory. They are copied after the builtin static files,
|
|
# so a file named "default.css" will overwrite the builtin "default.css".
|
|
#html_static_path = ['_static']
|
|
|
|
# -- Autodoc configuration ---------------------------------------------------
|
|
# https://www.sphinx-doc.org/en/master/usage/extensions/autodoc.html
|
|
|
|
autodoc_mock_imports = ['securesystemslib']
|
|
|
|
# Tone down the "tuf.api.metadata." repetition
|
|
add_module_names = False
|
|
python_use_unqualified_type_names = True
|
|
|
|
# Show typehints in argument doc lines, but not in signatures
|
|
autodoc_typehints = "description"
|