1. Benoît Allard
  2. sphinx


Georg Brandl  committed 1b1e28c

Add a rudimentary manpage for sphinx-apidoc.

  • Participants
  • Parent commits 913cbf2
  • Branches default

Comments (0)

Files changed (3)

File doc/conf.py

View file
  • Ignore whitespace
      '', 1),
     ('man/sphinx-quickstart', 'sphinx-quickstart', 'Sphinx documentation '
      'template generator', '', 1),
+    ('man/sphinx-apidoc', 'sphinx-apidoc', 'Sphinx API doc generator tool',
+     '', 1),
 texinfo_documents = [

File doc/man/sphinx-apidoc.rst

View file
  • Ignore whitespace
+sphinx-apidoc manual page
+**sphinx-apidoc** [*options*] -o <*outputdir*> <*sourcedir*> [*filenames* ...]
+:program:`sphinx-apidoc` is a tool for automatic generation of Sphinx sources
+that, using the autodoc extension, document a whole package in the style of
+other automatic API documentation tools.
+-o <outputdir>  Directory to place the output files.  If it does not exist,
+                it is created.
+-f, --force     Usually, apidoc does not overwrite files, unless this option
+                is given.
+-n, --dry-run   If given, apidoc does not create any files.
+-s <suffix>     Suffix for the source files generated, default is ``rst``.
+-d <maxdepth>   Maximum depth for the generated table of contents file.
+-T, --no-toc    Do not create a table of contents file.
+-F, --full      If given, a full Sphinx project is generated (``conf.py``,
+                ``Makefile`` etc.) using sphinx-quickstart.
+These options are used with ``-F``:
+-H <project>    Project name to put into the configuration.
+-A <author>     Author name(s) to put into the configuration.
+-V <version>    Project version, see :confval:`release`.
+-R <release>    Project release, see :confval:`release`.
+See also
+Etienne Desautels, <etienne.desautels@gmail.com>, Georg Brandl
+<georg@python.org> et al.

File sphinx/apidoc.py

View file
  • Ignore whitespace
             mastertocmaxdepth = opts.maxdepth,
             mastertoctree = text,
-        qs.generate(d, silent=True)
+        # XXX overwrites even without --force
+        if not opts.dryrun:
+            qs.generate(d, silent=True)
         print 'Creating quickstart project and Makefile.'
     elif not opts.notoc:
         create_modules_toc_file(modules, opts)