summaryrefslogtreecommitdiff
path: root/sphinx_conf.py
diff options
context:
space:
mode:
Diffstat (limited to 'sphinx_conf.py')
-rw-r--r--sphinx_conf.py62
1 files changed, 7 insertions, 55 deletions
diff --git a/sphinx_conf.py b/sphinx_conf.py
index f9f0eca..7d02133 100644
--- a/sphinx_conf.py
+++ b/sphinx_conf.py
@@ -1,87 +1,39 @@
1# Configuration file for the Sphinx documentation builder. 1# Configuration file for the Sphinx documentation builder.
2# 2#
3# This file only contains a selection of the most common options. For a full 3# For the full list of built-in configuration values, see the documentation:
4# list see the documentation: 4# https://www.sphinx-doc.org/en/master/usage/configuration.html
5# http://www.sphinx-doc.org/en/master/config
6
7# -- Path setup --------------------------------------------------------------
8
9# If extensions (or modules to document with autodoc) are in another directory,
10# add these directories to sys.path here. If the directory is relative to the
11# documentation root, use os.path.abspath to make it absolute, like shown here.
12#
13# import os
14# import sys
15# sys.path.insert(
16# 0,
17# '/home/sgs/development/gitprogs/python/pyotp2289/src/otp2289',
18# )
19
20 5
21# -- Project information ----------------------------------------------------- 6# -- Project information -----------------------------------------------------
7# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
22 8
23project = 'pyotp2289' 9project = 'pyotp2289'
24copyright = '2020-2023, Simeon Simeonov' 10copyright = '2020-2023, Simeon Simeonov'
25author = 'Simeon Simeonov' 11author = 'Simeon Simeonov'
26 12
27# The short X.Y version
28version = '1.2.0' 13version = '1.2.0'
29
30# The full version, including alpha/beta/rc tags
31release = '1.2.0' 14release = '1.2.0'
32 15
33
34# -- General configuration --------------------------------------------------- 16# -- General configuration ---------------------------------------------------
17# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
35 18
36# Add any Sphinx extension module names here, as strings. They can be
37# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
38# ones.
39extensions = [ 19extensions = [
40 'sphinx.ext.autodoc', 20 'sphinx.ext.autodoc',
41 'sphinx.ext.viewcode', 21 'sphinx.ext.viewcode',
42 'sphinx.ext.todo', 22 'sphinx.ext.todo',
43] 23]
44 24
45# Add any paths that contain templates here, relative to this directory.
46templates_path = ['_templates'] 25templates_path = ['_templates']
47
48# The suffix(es) of source filenames.
49# You can specify multiple suffix as a list of string:
50#
51source_suffix = ['.rst', '.md']
52
53# The language for content autogenerated by Sphinx. Refer to documentation
54# for a list of supported languages.
55#
56# This is also used if you do content translation via gettext catalogs.
57# Usually you set "language" from the command line for these cases.
58language = 'en'
59
60# List of patterns, relative to source directory, that match files and
61# directories to ignore when looking for source files.
62# This pattern also affects html_static_path and html_extra_path.
63exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store'] 26exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
64 27
28language = 'en'
65 29
66# -- Options for HTML output ------------------------------------------------- 30# -- Options for HTML output -------------------------------------------------
31# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
67 32
68# The theme to use for HTML and HTML Help pages. See the documentation for
69# a list of builtin themes.
70#
71html_theme = 'nature' 33html_theme = 'nature'
72
73# Add any paths that contain custom static files (such as style sheets) here,
74# relative to this directory. They are copied after the builtin static files,
75# so a file named "default.css" will overwrite the builtin "default.css".
76html_static_path = ['_static'] 34html_static_path = ['_static']
77 35
78
79# -- Extension configuration -------------------------------------------------
80
81# -- Options for todo extension ---------------------------------------------- 36# -- Options for todo extension ----------------------------------------------
37# https://www.sphinx-doc.org/en/master/usage/extensions/todo.html#configuration
82 38
83# If true, `todo` and `todoList` produce output, else they produce nothing.
84todo_include_todos = True 39todo_include_todos = True
85
86# Generated by running: sphinx-apidoc with:
87# -P -F -o html -H pyotp2289 -A "Simeon Simeonov" -V "1.1.0" otp2289