IntenseWebs/sphinx
3
0
Fork 0
mirror of https://github.com/sphinx-doc/sphinx.git synced 2025-02-25 18:55:22 -06:00
Code Issues Packages Projects Releases Wiki Activity

Add a bit more info.

Browse Source
This commit is contained in:
Georg Brandl 2010-02-28 23:03:38 +01:00
parent 2cbe10086f
commit 700c831ae7
1 changed files with 8 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
doc/invocation.rst
View File

@ -1,22 +1,23 @@
.. _invocation:
sphinx-build Invocation
=======================
Invocation of sphinx-build
==========================
A build is started with the :program:`sphinx-build` script. It is called like
this::
The :program:`sphinx-build` script builds a Sphinx documentation set. It is
called like this::
$ sphinx-build [options] sourcedir builddir [filenames]
where *sourcedir* is the :term:`source directory`, and *builddir* is the
directory in which you want to place the built documentation (it must be an
existing directory).
directory in which you want to place the built documentation. Most of the time,
you don't need to specify any *filenames*.
The :program:`sphinx-build` script has several options:
.. cmdoption:: -b buildername
Select a builder. The most common builders are:
The most important option: it selects a builder. The most common builders
are:
**html**
Build HTML pages. This is the default builder.