summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorshimizukawa <shimizukawa@gmail.com>2014-10-04 14:14:31 +0900
committershimizukawa <shimizukawa@gmail.com>2014-10-04 14:14:31 +0900
commitd8087c1808c4d55fbf82d320952d54905777ebcb (patch)
tree69c85c94cb69e51c54f1bc87790ae7ac4e847b53
parent1cdfb7b69f8dedce4c53c63cd8ca067fec9f17e9 (diff)
downloadsphinx-d8087c1808c4d55fbf82d320952d54905777ebcb.tar.gz
pull request #299 has been merged. Add documentation for sphinx-quickstart options, update a few statement and CHANGES. Closes #1501.
-rw-r--r--CHANGES2
-rw-r--r--doc/invocation.rst133
-rw-r--r--sphinx/quickstart.py11
3 files changed, 140 insertions, 6 deletions
diff --git a/CHANGES b/CHANGES
index f55a5a09..0d768936 100644
--- a/CHANGES
+++ b/CHANGES
@@ -91,6 +91,8 @@ Features added
Thanks to Takeshi Komiya.
* #1344: add :confval:`gettext_enables` to enable extracting 'index' to gettext
catalog output / applying translation catalog to generated documentation.
+* PR#299: add various options to sphinx-quickstart. Quiet mode option
+ ``--quiet`` will skips wizard mode. Thanks to WAKAYAMA shirou.
Bugs fixed
----------
diff --git a/doc/invocation.rst b/doc/invocation.rst
index d347f507..3316522a 100644
--- a/doc/invocation.rst
+++ b/doc/invocation.rst
@@ -1,5 +1,138 @@
+.. default-role:: any
+
.. _invocation:
+Invocation of sphinx-quickstart
+===============================
+
+The :program:`sphinx-quickstart` script generates a Sphinx documentation set.
+It is called like this::
+
+ $ sphinx-quickstart [options] [projectdir]
+
+where *projectdir* is the Sphinx documentation set directory in which you want
+to place. If you omit *projectdir*, files are generated into current directory
+by default.
+
+The :program:`sphinx-quickstart` script has several options:
+
+.. program:: sphinx-quickstart
+
+.. option:: -q, --quiet
+
+ Quiet mode that will skips interactive wizard to specify options.
+ This option requires `-p`, `-a` and `-v` options.
+
+.. option:: -h, --help, --version
+
+ Display usage summary or Sphinx version.
+
+
+Structure options
+-----------------
+
+.. option:: --sep
+
+ If specified, separate source and build directories.
+
+.. option:: --dot=DOT
+
+ Inside the root directory, two more directories will be created;
+ "_templates" for custom HTML templates and "_static" for custom stylesheets
+ and other static files. You can enter another prefix (such as ".") to
+ replace the underscore.
+
+Project basic options
+---------------------
+
+.. option:: -p PROJECT, --project=PROJECT
+
+ Project name will be set. (see :confval:`project`).
+
+.. option:: -a AUTHOR, --author=AUTHOR
+
+ Author names. (see :confval:`copyright`).
+
+.. option:: -v VERSION
+
+ Version of project. (see :confval:`version`).
+
+.. option:: -r RELEASE, --release=RELEASE
+
+ Release of project. (see :confval:`release`).
+
+.. option:: -l LANGUAGE, --language=LANGUAGE
+
+ Document language. (see :confval:`language`).
+
+.. option:: --suffix=SUFFIX
+
+ Source file suffix. (see :confval:`source_suffix`).
+
+.. option:: --master=MASTER
+
+ Master document name. (see :confval:`master_doc`).
+
+.. option:: --epub
+
+ Use epub.
+
+Extension options
+-----------------
+
+.. option:: --ext-autodoc
+
+ Enable `sphinx.ext.autodoc` extension.
+
+.. option:: --ext-doctest
+
+ Enable `sphinx.ext.doctest` extension.
+
+.. option:: --ext-intersphinx
+
+ Enable `sphinx.ext.intersphinx` extension.
+
+.. option:: --ext-todo
+
+ Enable `sphinx.ext.todo` extension.
+
+.. option:: --ext-coverage
+
+ Enable `sphinx.ext.coverage` extension.
+
+.. option:: --ext-pngmath
+
+ Enable `sphinx.ext.pngmath` extension.
+
+.. option:: --ext-mathjax
+
+ Enable `sphinx.ext.mathjax` extension.
+
+.. option:: --ext-ifconfig
+
+ Enable `sphinx.ext.ifconfig` extension.
+
+.. option:: --ext-viewcode
+
+ Enable `sphinx.ext.viewcode` extension.
+
+
+Makefile and Batchfile creation options
+---------------------------------------
+
+.. option:: --makefile, --no-makefile
+
+ Create (or not create) makefile.
+
+.. option:: --batchfile, --no-batchfile
+
+ Create (or not create) batchfile
+
+
+.. versionadded:: 1.3
+ Add various options for sphinx-quickstart invocation.
+
+
Invocation of sphinx-build
==========================
diff --git a/sphinx/quickstart.py b/sphinx/quickstart.py
index c37fa109..ce808e6d 100644
--- a/sphinx/quickstart.py
+++ b/sphinx/quickstart.py
@@ -1371,7 +1371,7 @@ def usage(argv, msg=None):
USAGE = """\
Sphinx v%s
-Usage: %%prog [options] folder
+Usage: %%prog [options] [projectdir]
""" % __version__
EPILOG = """\
@@ -1397,9 +1397,8 @@ def main(argv=sys.argv):
nocolor()
parser = optparse.OptionParser(USAGE, epilog=EPILOG,
+ version='Sphinx v%s' % __version__,
formatter=MyFormatter())
- parser.add_option('--version', action='store_true', dest='version',
- help='show version information and exit')
parser.add_option('-q', '--quiet', action='store_true', dest='quiet',
default=False,
help='quiet mode')
@@ -1429,16 +1428,16 @@ def main(argv=sys.argv):
default=False,
help='use epub')
- group = parser.add_option_group('Extensions')
+ group = parser.add_option_group('Extension options')
for ext in EXTENSIONS:
group.add_option('--ext-' + ext, action='store_true',
dest='ext_' + ext, default=False,
- help='add %s extention' % ext)
+ help='enable %s extension' % ext)
group = parser.add_option_group('Makefile and Batchfile creation')
group.add_option('--makefile', action='store_true', dest='makefile',
default=False,
- help='makefile')
+ help='create makefile')
group.add_option('--no-makefile', action='store_true', dest='no_makefile',
default=False,
help='not create makefile')