summaryrefslogtreecommitdiff
path: root/docs/doc_conventions.rst
Commit message (Collapse)AuthorAgeFilesLines
* Specify spacing when using autoclasskotfu2020-02-241-0/+15
|
* Add link to issue for more detail on how we determined our attribute ↵kotfu2020-02-141-0/+3
| | | | documentation approach
* Clean up class and method referenceskotfu2020-02-051-12/+4
| | | | | - In docs/api/cmd.rst, the `cmd2.Cmd` class was defined as `cmd2.cmd2.Cmd`, which required the extraneous `cmd2` every time we referenced it. This extra `cmd2` is no longer required. - always refer to a bare cmd2 using ``cmd2`` per our documentation conventions
* Fix doc8 errorkotfu2020-01-151-3/+3
|
* Clarify comment style for module data members and class attributeskotfu2020-01-151-0/+6
|
* Clarify how to document instance attributeskotfu2020-01-151-0/+14
|
* Reorganize doc conventionskotfu2019-11-301-46/+41
|
* Clean out some unused cruftkotfu2019-11-291-19/+5
|
* Write details for two sectionskotfu2019-11-271-15/+104
| | | | | - titles and headings - referencing methods
* Add doc8 documentation style checkingkotfu2019-07-061-23/+40
| | | | | | - add dev dependency - add doc8 to tasks.py - fix all doc8 errors
* Added a walkthrough of constructing a simple application to the overviewkotfu2019-07-051-0/+2
| | | | For #709
* Major overhaul of documentation structure for #709kotfu2019-07-021-0/+109