summaryrefslogtreecommitdiff
path: root/sphinx_conf.py
diff options
context:
space:
mode:
Diffstat (limited to 'sphinx_conf.py')
-rw-r--r--sphinx_conf.py17
1 files changed, 9 insertions, 8 deletions
diff --git a/sphinx_conf.py b/sphinx_conf.py
index 3bef39e..0e2d594 100644
--- a/sphinx_conf.py
+++ b/sphinx_conf.py
@@ -1,3 +1,4 @@
1"""pyotp2289 sphinx configuration"""
1# Configuration file for the Sphinx documentation builder. 2# Configuration file for the Sphinx documentation builder.
2# 3#
3# For the full list of built-in configuration values, see the documentation: 4# For the full list of built-in configuration values, see the documentation:
@@ -7,20 +8,16 @@
7# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information 8# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
8 9
9project = 'pyotp2289' 10project = 'pyotp2289'
10copyright = '2020-2023, Simeon Simeonov' 11copyright = '2020-2026, Simeon Simeonov' # noqa: A001
11author = 'Simeon Simeonov' 12author = 'Simeon Simeonov'
12 13
13version = '1.2.1' 14version = '2.0.0'
14release = '1.2.1' 15release = '2.0.0'
15 16
16# -- General configuration --------------------------------------------------- 17# -- General configuration ---------------------------------------------------
17# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration 18# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
18 19
19extensions = [ 20extensions = ['sphinx.ext.autodoc', 'sphinx.ext.viewcode', 'sphinx.ext.todo']
20 'sphinx.ext.autodoc',
21 'sphinx.ext.viewcode',
22 'sphinx.ext.todo',
23]
24 21
25templates_path = ['_templates'] 22templates_path = ['_templates']
26exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store'] 23exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
@@ -32,8 +29,12 @@ language = 'en'
32 29
33html_theme = 'nature' 30html_theme = 'nature'
34html_static_path = ['_static'] 31html_static_path = ['_static']
32html_sidebars = {'**': ['globaltoc.html', 'searchbox.html']}
35 33
36# -- Options for todo extension ---------------------------------------------- 34# -- Options for todo extension ----------------------------------------------
37# https://www.sphinx-doc.org/en/master/usage/extensions/todo.html#configuration 35# https://www.sphinx-doc.org/en/master/usage/extensions/todo.html#configuration
38 36
39todo_include_todos = True 37todo_include_todos = True
38
39# Generated by running: sphinx-apidoc with:
40# -P -F -o html -H pyotp2289 -A "Simeon Simeonov" -V "2.0.0" src/otp2289