File tree Expand file tree Collapse file tree 1 file changed +14
-0
lines changed Expand file tree Collapse file tree 1 file changed +14
-0
lines changed Original file line number Diff line number Diff line change @@ -149,8 +149,22 @@ And somewhere within your module documentation, you should add this:
149149 Before that, you might have to use the currentmodule _ directive to select your
150150own module. Using automodule _ should also do.
151151
152+ If you want to use Sphinx's nitpicky _ setting,
153+ you'll have to add a few things to ``nitpick_ignore ``:
154+
155+ .. code :: python
156+
157+ nitpicky = True
158+ nitpick_ignore = [
159+ (' py:class' , ' optional' ),
160+ (' py:class' , ' buffer' ),
161+ (' py:class' , ' CData pointer' ),
162+ ]
163+
152164 .. _Sphinx : http://www.sphinx-doc.org/
153165.. _autodoc : http://www.sphinx-doc.org/ext/autodoc.html
154166.. _currentmodule : http://www.sphinx-doc.org/domains.html
155167 #directive-py:currentmodule
156168.. _automodule : http://www.sphinx-doc.org/ext/autodoc.html#directive-automodule
169+ .. _nitpicky : https://www.sphinx-doc.org/en/master/
170+ usage/configuration.html#confval-nitpicky
You can’t perform that action at this time.
0 commit comments