Commit Graph

21 Commits

Author SHA1 Message Date
Timotheus Kampik
ec9f373bfa #3751 use double back ticks 2017-08-23 00:05:56 +02:00
Timotheus Kampik
6413833a4f #3751 work in feedback 2017-08-02 00:20:49 +02:00
Timotheus Kampik
68fe4b2d6f #3751 document -M command line option 2017-07-16 09:50:08 +02:00
Stephen Finucane
348bf2a421 doc: Remove 'Author' section from man pages
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>
2017-07-11 16:08:49 +01:00
Stephen Finucane
65a81e2056 doc: Add sphinx-autogen man page
This wasn't documented in depth anywhere, so do just that.

Signed-off-by: Stephen Finucane <stephen@that.guru>
2017-07-11 16:08:40 +01:00
Stephen Finucane
9b7525d47d doc: Remove 'invocation' document
This contains no useful information at this point. Better to simply drop
it.

Signed-off-by: Stephen Finucane <stephen@that.guru>
2017-07-11 16:08:33 +01:00
Stephen Finucane
12e190f35f doc: Update sphinx-build man page
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>
2017-07-11 16:08:29 +01:00
Stephen Finucane
2cfa2bc673 doc: Update sphinx-quickstart man page
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>
2017-07-11 16:07:36 +01:00
Stephen Finucane
c244a7c9a9 doc: Update sphinx-apidoc man page
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>
2017-07-11 15:59:32 +01:00
Takeshi KOMIYA
5682dbf937 Fix #2892: Added `-a (--append-syspath) option to sphinx-apidoc` 2016-08-24 23:55:15 +09:00
EricFromCanada
65e924a3e4 rewrapping paragraphs when over 80 characters wide 2014-06-18 11:53:25 -04:00
Georg Brandl
b944c843f5 Add warnings that autodoc imports the modules. 2014-03-05 07:45:45 +01:00
Georg Brandl
31aed07386 Closes #1156: bring manpage up to scratch with current options and builders. 2014-01-12 16:07:21 +01:00
dc mouser
3f888742ff Added option to apidoc to have it output each module to its own page and updated apidoc docs. 2013-09-08 16:25:41 -05:00
Jonathan Waltman
beae650645 xml: Update sphinx-build documentation 2012-12-10 02:41:12 -06:00
Georg Brandl
38ebe67c4e Closes #585: document sphinx-apidoc. 2011-10-07 12:47:58 +02:00
Georg Brandl
ff940a16b6 Add a rudimentary manpage for sphinx-apidoc. 2011-10-07 12:27:19 +02:00
Jonathan Waltman
9f9c753f7e Mention the texinfo builder in the sphinx-build man page 2011-01-28 02:34:53 -06:00
Georg Brandl
3d01c2c95f #282: Added a "nitpicky" mode that emits warnings for all missing references.
It is activated by the ``-n`` command-line switch or the ``nitpicky`` config value.
2010-02-28 12:13:55 +01:00
Georg Brandl
832e290acd Add "orphan" metadata entry to suppress non-toctree-inclusion warnings. 2010-02-25 22:49:54 +01:00
Georg Brandl
07a658e50c Remove hand-written manpages, add rst documents to be built with the manpage builder. 2010-02-25 22:22:01 +01:00