Skip to content

Commit efbcf78

Browse files
committed
docs: update sphinx configuration
1 parent 5417954 commit efbcf78

3 files changed

Lines changed: 13 additions & 31 deletions

File tree

docs/conf.py

Lines changed: 7 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
# Configuration file for the Sphinx documentation builder.
22
#
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:
54
# https://www.sphinx-doc.org/en/master/usage/configuration.html
65

76
# -- Path setup --------------------------------------------------------------
@@ -15,56 +14,35 @@
1514
sys.path.insert(0, os.path.abspath('..'))
1615

1716
# -- Project information -----------------------------------------------------
17+
# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
1818

1919
project = u'python-periphery'
2020
copyright = u'2015-2023, vsergeev / Ivan (Vanya) A. Sergeev'
2121
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'
2723

2824
# -- General configuration ---------------------------------------------------
25+
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
2926

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.
3327
extensions = [
3428
'sphinx.ext.autodoc',
3529
'sphinx.ext.napoleon',
3630
'sphinx.ext.todo',
3731
'sphinx.ext.viewcode',
32+
'sphinx_rtd_theme',
3833
]
3934

4035
autoclass_content = 'init'
4136
autodoc_member_order = 'bysource'
4237

43-
# Add any paths that contain templates here, relative to this directory.
4438
templates_path = ['_templates']
39+
exclude_patterns = ['_build']
4540

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.
5541
pygments_style = 'sphinx'
5642

5743
# -- Options for HTML output -------------------------------------------------
44+
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
5845

59-
# The theme to use for HTML and HTML Help pages. See the documentation for
60-
# a list of builtin themes.
61-
#
6246
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".
6747
html_static_path = ['_static']
68-
69-
# If true, links to the reST sources are added to the pages.
7048
html_show_sourcelink = False

docs/gpio.rst

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,12 +23,16 @@ API
2323
---
2424

2525
.. class:: periphery.GPIO(path, line, direction)
26+
:noindex:
2627

27-
.. autoclass:: periphery.CdevGPIO
28+
.. autoclass:: periphery.gpio_cdev2.Cdev2GPIO
29+
:noindex:
2830

2931
.. class:: periphery.GPIO(line, direction)
32+
:noindex:
3033

3134
.. autoclass:: periphery.SysfsGPIO
35+
:noindex:
3236

3337
.. autoclass:: periphery.GPIO
3438
:members:

docs/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ Contents
1717
--------
1818

1919
.. toctree::
20-
:maxdepth: 4
20+
:maxdepth: 1
2121

2222
gpio
2323
led

0 commit comments

Comments
 (0)