Skip to content

Commit efd3313

Browse files
committed
update docs conf
1 parent db55d41 commit efd3313

File tree

1 file changed

+21
-18
lines changed

1 file changed

+21
-18
lines changed

docs/conf.py

Lines changed: 21 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@
2121
"sphinx.ext.todo",
2222
]
2323

24+
# TODO: Please Read!
2425
# Uncomment the below if you use native CircuitPython modules such as
2526
# digitalio, micropython and busio. List the modules you use. Without it, the
2627
# autodoc module docs will fail to generate with a warning.
@@ -35,6 +36,9 @@
3536
"CircuitPython": ("https://docs.circuitpython.org/en/latest/", None),
3637
}
3738

39+
# Show the docstring from both the class and its __init__() method.
40+
autoclass_content = "both"
41+
3842
# Add any paths that contain templates here, relative to this directory.
3943
templates_path = ["_templates"]
4044

@@ -72,7 +76,13 @@
7276
# List of patterns, relative to source directory, that match files and
7377
# directories to ignore when looking for source files.
7478
# This patterns also effect to html_static_path and html_extra_path
75-
exclude_patterns = ["_build", "Thumbs.db", ".DS_Store", ".env", "CODE_OF_CONDUCT.md"]
79+
exclude_patterns = [
80+
"_build",
81+
"Thumbs.db",
82+
".DS_Store",
83+
".env",
84+
"CODE_OF_CONDUCT.md",
85+
]
7686

7787
# The reST default role (used for this markup: `text`) to use for all
7888
# documents.
@@ -92,48 +102,41 @@
92102
# If this is True, todo emits a warning for each TODO entries. The default is False.
93103
todo_emit_warnings = True
94104

105+
napoleon_numpy_docstring = False
95106

96107
# -- Options for HTML output ----------------------------------------------
97108

98109
# The theme to use for HTML and HTML Help pages. See the documentation for
99110
# a list of builtin themes.
100111
#
101-
on_rtd = os.environ.get("READTHEDOCS", None) == "True"
102-
103-
if not on_rtd: # only import and set the theme if we're building docs locally
104-
try:
105-
import sphinx_rtd_theme
112+
import sphinx_rtd_theme
106113

107-
html_theme = "sphinx_rtd_theme"
108-
html_theme_path = [sphinx_rtd_theme.get_html_theme_path(), "."]
109-
except ImportError:
110-
html_theme = "default"
111-
html_theme_path = ["."]
112-
else:
113-
html_theme_path = ["."]
114+
html_theme = "sphinx_rtd_theme"
114115

115116
# Add any paths that contain custom static files (such as style sheets) here,
116117
# relative to this directory. They are copied after the builtin static files,
117118
# so a file named "default.css" will overwrite the builtin "default.css".
118119
html_static_path = ["_static"]
119120

121+
# The name of an image file (relative to this directory) to use as a favicon of
122+
# the docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
123+
# pixels large.
124+
#
125+
html_favicon = "_static/favicon.ico"
126+
120127
# Output file base name for HTML help builder.
121128
htmlhelp_basename = "AdafruitNAU7802Librarydoc"
122129

123130
# -- Options for LaTeX output ---------------------------------------------
124131

125132
latex_elements = {
126133
# The paper size ('letterpaper' or 'a4paper').
127-
#
128134
# 'papersize': 'letterpaper',
129135
# The font size ('10pt', '11pt' or '12pt').
130-
#
131136
# 'pointsize': '10pt',
132137
# Additional stuff for the LaTeX preamble.
133-
#
134138
# 'preamble': '',
135139
# Latex figure (float) alignment
136-
#
137140
# 'figure_align': 'htbp',
138141
}
139142

@@ -161,7 +164,7 @@
161164
"Adafruit NAU7802 Library Documentation",
162165
[author],
163166
1,
164-
)
167+
),
165168
]
166169

167170
# -- Options for Texinfo output -------------------------------------------

0 commit comments

Comments
 (0)