summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorWes Turner <wes.turner@gmail.com>2014-10-14 02:25:56 +0000
committerWes Turner <wes.turner@gmail.com>2014-10-14 02:25:56 +0000
commit540d1dabd9552589712023f3eb5c2ea2026fc7f9 (patch)
treed669124ee527a3dedf05ba01df0a3cfe88106c32
parente7e402c67829bc9ef1756a6f5f7ad1b7794d3ee7 (diff)
downloadsphinx-540d1dabd9552589712023f3eb5c2ea2026fc7f9.tar.gz
DOC: invocation.rst: sphinx-apidoc -M option
-rw-r--r--doc/invocation.rst5
1 files changed, 5 insertions, 0 deletions
diff --git a/doc/invocation.rst b/doc/invocation.rst
index 3316522a..79ac1995 100644
--- a/doc/invocation.rst
+++ b/doc/invocation.rst
@@ -438,6 +438,11 @@ The :program:`sphinx-apidoc` script has several options:
to default values, but you can influence the most important ones using the
following options.
+.. option:: -M
+
+ This option makes sphinx-apidoc put module documentation before submodule
+ documentation.
+
.. option:: -H project
Sets the project name to put in generated files (see :confval:`project`).