|
1 | 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 |
4 | | -# list see the documentation: |
| 3 | +# For the full list of built-in configuration values, see the documentation: |
5 | 4 | # https://www.sphinx-doc.org/en/master/usage/configuration.html |
6 | 5 |
|
7 | 6 | # -- Path setup -------------------------------------------------------------- |
|
15 | 14 | sys.path.insert(0, os.path.abspath('..')) |
16 | 15 |
|
17 | 16 | # -- Project information ----------------------------------------------------- |
| 17 | +# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information |
18 | 18 |
|
19 | 19 | project = u'python-periphery' |
20 | 20 | copyright = u'2015-2023, vsergeev / Ivan (Vanya) A. Sergeev' |
21 | 21 | author = u'Vanya A. Sergeev' |
22 | | - |
23 | | -# The short X.Y version. |
24 | | -version = '2.4.1' |
25 | | -# The full version, including alpha/beta/rc tags. |
26 | | -release = version |
| 22 | +release = '2.4.1' |
27 | 23 |
|
28 | 24 | # -- General configuration --------------------------------------------------- |
| 25 | +# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration |
29 | 26 |
|
30 | | -# Add any Sphinx extension module names here, as strings. They can be |
31 | | -# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom |
32 | | -# ones. |
33 | 27 | extensions = [ |
34 | 28 | 'sphinx.ext.autodoc', |
35 | 29 | 'sphinx.ext.napoleon', |
36 | 30 | 'sphinx.ext.todo', |
37 | 31 | 'sphinx.ext.viewcode', |
| 32 | + 'sphinx_rtd_theme', |
38 | 33 | ] |
39 | 34 |
|
40 | 35 | autoclass_content = 'init' |
41 | 36 | autodoc_member_order = 'bysource' |
42 | 37 |
|
43 | | -# Add any paths that contain templates here, relative to this directory. |
44 | 38 | templates_path = ['_templates'] |
| 39 | +exclude_patterns = ['_build'] |
45 | 40 |
|
46 | | -# The master toctree document. |
47 | | -master_doc = 'index' |
48 | | - |
49 | | -# List of patterns, relative to source directory, that match files and |
50 | | -# directories to ignore when looking for source files. |
51 | | -# This pattern also affects html_static_path and html_extra_path. |
52 | | -exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store'] |
53 | | - |
54 | | -# The name of the Pygments (syntax highlighting) style to use. |
55 | 41 | pygments_style = 'sphinx' |
56 | 42 |
|
57 | 43 | # -- Options for HTML output ------------------------------------------------- |
| 44 | +# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output |
58 | 45 |
|
59 | | -# The theme to use for HTML and HTML Help pages. See the documentation for |
60 | | -# a list of builtin themes. |
61 | | -# |
62 | 46 | html_theme = 'sphinx_rtd_theme' |
63 | | - |
64 | | -# Add any paths that contain custom static files (such as style sheets) here, |
65 | | -# relative to this directory. They are copied after the builtin static files, |
66 | | -# so a file named "default.css" will overwrite the builtin "default.css". |
67 | 47 | html_static_path = ['_static'] |
68 | | - |
69 | | -# If true, links to the reST sources are added to the pages. |
70 | 48 | html_show_sourcelink = False |
0 commit comments