diff options
| author | kotfu <kotfu@kotfu.net> | 2020-02-24 21:39:27 -0700 |
|---|---|---|
| committer | kotfu <kotfu@kotfu.net> | 2020-02-24 21:39:27 -0700 |
| commit | be84cb1c469ebbfc365a15e3096d786756ce5b76 (patch) | |
| tree | 9ee2b2b2801f9f2941dbd6b7099e1079b72fa50f /docs/doc_conventions.rst | |
| parent | 52c2cde78de1f9360b3cf9902e6517036870d0b6 (diff) | |
| download | cmd2-git-be84cb1c469ebbfc365a15e3096d786756ce5b76.tar.gz | |
Specify spacing when using autoclass
Diffstat (limited to 'docs/doc_conventions.rst')
| -rw-r--r-- | docs/doc_conventions.rst | 15 |
1 files changed, 15 insertions, 0 deletions
diff --git a/docs/doc_conventions.rst b/docs/doc_conventions.rst index c37a4825..6adad4c9 100644 --- a/docs/doc_conventions.rst +++ b/docs/doc_conventions.rst @@ -159,6 +159,21 @@ comment instead of just #), or in a docstring after the definition. This project has standardized on the docstring after the definition approach. Do not use the specially formatted comment approach. +When using the Sphix ``autoclass`` directive, it must be preceded by two blank +lines like so: + +.. code-block:: rst + + Classes for storing the history of previously entered commands. + + + .. autoclass:: cmd2.history.History + :members: + + + .. autoclass:: cmd2.history.HistoryItem + :members: + Links to API Reference ---------------------- |