Commit Graph

9 Commits

Author SHA1 Message Date
Stephen Finucane
9f7f5f2a44 doc: Add missing sphinx-apidocs opt, envvar
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
2017-12-28 23:00:53 +00: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
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
Georg Brandl
b944c843f5 Add warnings that autodoc imports the modules. 2014-03-05 07:45:45 +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
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