diff options
| author | Roland Meister <devnull@localhost> | 2012-02-21 21:00:14 +0100 |
|---|---|---|
| committer | Roland Meister <devnull@localhost> | 2012-02-21 21:00:14 +0100 |
| commit | 0cbae1ffe2ba0cda931e6d23d342bdc530d49cf2 (patch) | |
| tree | 89745e757dbf5746140460741572d6c8e07305f0 /doc/tutorial.rst | |
| parent | 2845f0145d340a5bd6543fbf5dabe2d3cad95c8c (diff) | |
| parent | fa16f15fccef71aee359138d9e7d5b745bf15b16 (diff) | |
| download | sphinx-0cbae1ffe2ba0cda931e6d23d342bdc530d49cf2.tar.gz | |
Merge with arlaneenalra/sphinx
Diffstat (limited to 'doc/tutorial.rst')
| -rw-r--r-- | doc/tutorial.rst | 9 |
1 files changed, 9 insertions, 0 deletions
diff --git a/doc/tutorial.rst b/doc/tutorial.rst index fa6ee2ab..b0e1d486 100644 --- a/doc/tutorial.rst +++ b/doc/tutorial.rst @@ -26,6 +26,9 @@ configuration values from a few questions it asks you. Just run :: and answer its questions. (Be sure to say yes to the "autodoc" extension.) +There is also an automatic "API documentation" generator called +:program:`sphinx-apidoc`; see :ref:`invocation-apidoc` for details. + Defining document structure --------------------------- @@ -125,6 +128,12 @@ to run :: to build HTML docs in the build directory you chose. Execute ``make`` without an argument to see which targets are available. +.. admonition:: How do I generate PDF documents? + + ``make latexpdf`` runs the :mod:`LaTeX builder + <sphinx.builders.latex.LaTeXBuilder>` and readily invokes the pdfTeX + toolchain for you. + Documenting objects ------------------- |