IntenseWebs/sphinx
3
0
Fork 0
mirror of https://github.com/sphinx-doc/sphinx.git synced 2025-02-25 18:55:22 -06:00
Code Issues Packages Projects Releases Wiki Activity

Enable 'nit-picky mode' for Sphinx's documentation

Browse Source 
Fix several reference errors throughout the documentation and set
``nitpick_ignore`` in ``doc/conf.py``.
This commit is contained in:
Adam Turner
2023-04-06 23:11:39 +01:00
parent b2349254fc
commit 7ecf037280
31 changed files with 206 additions and 133 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
doc/man/sphinx-apidoc.rst
View File

@@ -11,8 +11,8 @@ Description
-----------
:program:`sphinx-apidoc` is a tool for automatic generation of Sphinx sources
that, using the :rst:dir:`autodoc` extension, document a whole package in the
style of other automatic API documentation tools.
that, using the :py:mod:`~sphinx.ext.autodoc` extension, document a whole
package in the style of other automatic API documentation tools.
*MODULE_PATH* is the path to a Python package to document, and *OUTPUT_PATH* is
the directory where the generated sources are placed. Any *EXCLUDE_PATTERN*\s