summaryrefslogtreecommitdiff
path: root/doc/man/sphinx-apidoc.rst
Commit message (Collapse)AuthorAgeFilesLines
* Enable 'nit-picky mode' for Sphinx's documentationAdam Turner2023-04-061-2/+2
| | | | | Fix several reference errors throughout the documentation and set ``nitpick_ignore`` in ``doc/conf.py``.
* Add missing default arguments in sphinx-apidoc.rst (#11084)jgart2023-01-051-2/+2
| | | Add the missing default arguments to two CLI flags, ``-l`` and ``-d``
* Close #8326: Rename master_doc to root_docTakeshi KOMIYA2021-02-281-1/+1
| | | | | | To describe the purpose more accurately, the `master_doc` is now renamed to `root_doc`. The old name is still available. But it is recommeneded to use new one from now on.
* Merge branch '2.0'Takeshi KOMIYA2020-02-091-0/+5
|\
| * apidoc: Add ``-q`` option for quiet mode (refs: #6772)Takeshi KOMIYA2020-02-011-0/+5
| |
* | Get rid of comma in sphinx-apidoc documentationJacob Stevens-Haas2019-09-011-1/+1
|/ | | | #6674 Nixing the comma in `EXCLUDE PATTERN, ...` because it's not supposed to be there. See the issue for the research.
* Close #5602: apidoc: Add ``--templatedir`` optionTakeshi KOMIYA2019-06-161-0/+24
|
* doclinter: restrict by 90 columnsTakeshi KOMIYA2019-05-261-1/+2
|
* Fix various spelling typosjfbu2018-12-271-1/+1
|
* Fix #5362: apidoc: Add ``--toc`` option to change the filename of ToCTakeshi KOMIYA2018-09-061-0/+4
|
* doc: Fix broken linkTakeshi KOMIYA2018-04-121-2/+4
|
* doc: Resolve inconsistent 'sphinx-apidoc' docsStephen Finucane2018-01-201-6/+9
| | | | | | | | | The signature for the 'sphinx-apidoc' call differs between the man page and the output of 'sphinx-apidoc --help'. Resolve this by considering the 'sphinx-apidoc --help' output the canonical reference. Signed-off-by: Stephen Finucane <stephen@that.guru> Fixes: #4451
* doc: Add missing sphinx-apidocs opt, envvarStephen Finucane2017-12-281-1/+9
| | | | | | | | | | | | | | | | Add docs for '--module-first' option and 'SPHINX_APIDOC_OPTIONS' environment variable. Per the closest thing we have to official man page guidelines [1]: ENVIRONMENT lists all environment variables that affect the program or function and how they affect it. [1] https://linux.die.net/man/7/man-pages Signed-off-by: Stephen Finucane <stephen@that.guru> Fixes #2250
* doc: Remove 'Author' section from man pagesStephen Finucane2017-07-111-6/+0
| | | | | | | | | | | | | | | | Per the closest thing we have to official man page guidelines [1]: Use of an AUTHORS section is strongly discouraged. Generally, it is better not to clutter every page with a list of (over time potentially numerous) authors; if you write or significantly amend a page, add a copyright notice as a comment in the source file. We already do a good job of tracking authors in the AUTHORS file, so we can remove this. [1] https://linux.die.net/man/7/man-pages Signed-off-by: Stephen Finucane <stephen@that.guru>
* doc: Add sphinx-autogen man pageStephen Finucane2017-07-111-1/+1
| | | | | | This wasn't documented in depth anywhere, so do just that. Signed-off-by: Stephen Finucane <stephen@that.guru>
* doc: Update sphinx-apidoc man pageStephen Finucane2017-07-111-33/+94
| | | | | | | This man page wasn't making full use of Sphinx's own features. Update it to do so, and remove the duplicated information from 'invocation'. Signed-off-by: Stephen Finucane <stephen@that.guru>
* Fix #2892: Added ``-a`` (``--append-syspath``) option to `sphinx-apidoc`Takeshi KOMIYA2016-08-241-0/+1
|
* Add warnings that autodoc imports the modules.Georg Brandl2014-03-051-11/+23
|
* Added option to apidoc to have it output each module to its own page and ↵dc mouser2013-09-081-0/+1
| | | | updated apidoc docs.
* Closes #585: document sphinx-apidoc.Georg Brandl2011-10-071-3/+6
|
* Add a rudimentary manpage for sphinx-apidoc.Georg Brandl2011-10-071-0/+52
View Lorry Controller Status