1SPHINX-APIDOC(1)                    Sphinx                    SPHINX-APIDOC(1)
2
3
4

NAME

6       sphinx-apidoc - Sphinx API doc generator tool
7

SYNOPSIS

9       sphinx-apidoc [options] -o <outputdir> <sourcedir> [pathnames ...]
10

DESCRIPTION

12       sphinx-apidoc  is  a  tool  for  automatic generation of Sphinx sources
13       that, using the autodoc extension, document  a  whole  package  in  the
14       style of other automatic API documentation tools.
15
16       sourcedir  must  point  to  a  Python package.  Any pathnames given are
17       paths to be excluded from the generation.
18

OPTIONS

20       -o <outputdir>
21              Directory to place the output files.  If it does not  exist,  it
22              is created.
23
24       -f, --force
25              Usually,  apidoc does not overwrite files, unless this option is
26              given.
27
28       -n, --dry-run
29              If given, apidoc does not create any files.
30
31       -s <suffix>
32              Suffix for the source files generated, default is rst.
33
34       -d <maxdepth>
35              Maximum depth for the generated table of contents file.
36
37       -T, --no-toc
38              Do not create a table of contents file.
39
40       -F, --full
41              If given, a full Sphinx project is generated (conf.py,  Makefile
42              etc.) using sphinx-quickstart.
43
44       These options are used with -F:
45
46       -H <project>
47              Project name to put into the configuration.
48
49       -A <author>
50              Author name(s) to put into the configuration.
51
52       -V <version>
53              Project version.
54
55       -R <release>
56              Project release.
57

SEE ALSO

59       sphinx-build(1)
60

AUTHOR

62       Etienne   Desautels,  <etienne.desautels@gmail.com>,  Georg  Brandl  <‐
63       georg@python.org> et al.
64

66       2007-2011, Georg Brandl
67
68
69
70
711.1.3                          November 05, 2016              SPHINX-APIDOC(1)
Impressum