diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/doc_conventions.rst | 14 |
1 files changed, 14 insertions, 0 deletions
diff --git a/docs/doc_conventions.rst b/docs/doc_conventions.rst index 082235da..e577fd50 100644 --- a/docs/doc_conventions.rst +++ b/docs/doc_conventions.rst @@ -140,6 +140,20 @@ and See :ref:`custom title<features/argument_processing:Help Messages>` +API Documentation +----------------- + +The API documentation is mostly pulled from docstrings in the source code using +the Sphinx `autodoc +<https://www.sphinx-doc.org/en/master/usage/extensions/autodoc.html>`_ +extension. However, Sphinx has issues generating documentation for instance +attributes (see `cmd2 issue 821 +<https://github.com/python-cmd2/cmd2/issues/821>`_ for the full discussion). We +have chosen to not use code as the source of instance attribute documentation. +Instead, it is added manually to the documentation files in ``cmd2/docs/api``. +See ``cmd2/docs/api/cmd.rst`` to see how to add documentation for an attribute. + + Links to API Reference ---------------------- |