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 140140See :ref: `custom title<features/argument_processing:Help Messages> `
141141
142142
143+ API Documentation
144+ -----------------
145+
146+ The API documentation is mostly pulled from docstrings in the source code using
147+ the Sphinx `autodoc
148+ <https://www.sphinx-doc.org/en/master/usage/extensions/autodoc.html> `_
149+ extension. However, Sphinx has issues generating documentation for instance
150+ attributes (see `cmd2 issue 821
151+ <https://github.com/python-cmd2/cmd2/issues/821> `_ for the full discussion). We
152+ have chosen to not use code as the source of instance attribute documentation.
153+ Instead, it is added manually to the documentation files in ``cmd2/docs/api ``.
154+ See ``cmd2/docs/api/cmd.rst `` to see how to add documentation for an attribute.
155+
156+
143157Links to API Reference
144158----------------------
145159
You can’t perform that action at this time.
0 commit comments