Skip to content

Commit 791879d

Browse files
committed
fixes #1568 Include python-tuf version in documentation
Signed-off-by: gkum99 <h20220014@goa.bits-pilani.ac.in>
1 parent 368dadf commit 791879d

1 file changed

Lines changed: 22 additions & 19 deletions

File tree

docs/conf.py

Lines changed: 22 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -12,56 +12,56 @@
1212
#
1313
import os
1414
import sys
15-
sys.path.insert(0, os.path.abspath(os.path.join('..')))
15+
16+
sys.path.insert(0, os.path.abspath(os.path.join("..")))
1617

1718
import tuf
1819

1920
# -- Project information -----------------------------------------------------
2021

21-
project = 'TUF'
22-
copyright = '2021, New York University and the TUF contributors'
23-
author = 'New York University and the TUF contributors'
22+
project = "TUF"
23+
copyright = "2021, New York University and the TUF contributors"
24+
author = "New York University and the TUF contributors"
2425

2526

2627
# -- General configuration ---------------------------------------------------
2728

28-
master_doc = 'index'
29+
master_doc = "index"
2930

3031
# Add any Sphinx extension module names here, as strings. They can be
3132
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
3233
# ones.
3334
extensions = [
34-
'sphinx.ext.napoleon', 'sphinx.ext.autosummary',
35-
'sphinx.ext.autosectionlabel'
35+
"sphinx.ext.napoleon",
36+
"sphinx.ext.autosummary",
37+
"sphinx.ext.autosectionlabel",
3638
]
3739

3840
autosectionlabel_prefix_document = True
3941

4042
# Add any paths that contain templates here, relative to this directory.
41-
templates_path = ['_templates']
43+
templates_path = ["_templates"]
4244

4345
# -- Options for HTML output -------------------------------------------------
4446

4547
# The theme to use for HTML and HTML Help pages. See the documentation for
4648
# a list of builtin themes.
4749
#
48-
html_theme = 'sphinx_rtd_theme'
49-
html_theme_options = {
50-
'logo_only': True
51-
}
52-
html_logo = 'tuf-horizontal-white.png'
53-
html_favicon = 'tuf-icon-32.png'
50+
html_theme = "sphinx_rtd_theme"
51+
html_theme_options = {"logo_only": True}
52+
html_logo = "tuf-horizontal-white.png"
53+
html_favicon = "tuf-icon-32.png"
5454

5555

5656
# Add any paths that contain custom static files (such as style sheets) here,
5757
# relative to this directory. They are copied after the builtin static files,
5858
# so a file named "default.css" will overwrite the builtin "default.css".
59-
#html_static_path = ['_static']
59+
# html_static_path = ['_static']
6060

6161
# -- Autodoc configuration ---------------------------------------------------
6262
# https://www.sphinx-doc.org/en/master/usage/extensions/autodoc.html
6363

64-
autodoc_mock_imports = ['securesystemslib']
64+
autodoc_mock_imports = ["securesystemslib"]
6565

6666
# Tone down the "tuf.api.metadata." repetition
6767
add_module_names = False
@@ -71,7 +71,10 @@
7171
autodoc_typehints = "description"
7272

7373
autodoc_default_options = {
74-
'members': True,
75-
'inherited-members': 'Exception', # excl. members inherited from 'Exception'
76-
'exclude-members': 'to_dict, from_dict'
74+
"members": True,
75+
"inherited-members": "Exception", # excl. members inherited from 'Exception'
76+
"exclude-members": "to_dict, from_dict",
7777
}
78+
79+
# Version
80+
version = tuf.__version__

0 commit comments

Comments
 (0)