summaryrefslogtreecommitdiff
path: root/sphinx/quickstart.py
diff options
context:
space:
mode:
authorGeorg Brandl <georg@python.org>2008-11-24 20:42:05 +0100
committerGeorg Brandl <georg@python.org>2008-11-24 20:42:05 +0100
commit30bb2bc9fe9895de00dd0f5dfe62e87d5f70e4db (patch)
treeb20fe82808bee26c7136cb3ee8bde17c679ef277 /sphinx/quickstart.py
parent46b66892402d56652cd4824de39535f9293ca864 (diff)
downloadsphinx-git-30bb2bc9fe9895de00dd0f5dfe62e87d5f70e4db.tar.gz
Fix #54: awkward wording in quickstart.
Diffstat (limited to 'sphinx/quickstart.py')
-rw-r--r--sphinx/quickstart.py15
1 files changed, 9 insertions, 6 deletions
diff --git a/sphinx/quickstart.py b/sphinx/quickstart.py
index 030245355..a66f7ecaf 100644
--- a/sphinx/quickstart.py
+++ b/sphinx/quickstart.py
@@ -509,12 +509,15 @@ directly.'''
print bold('Finished: An initial directory structure has been created.')
print '''
You should now populate your master file %s and create other documentation
-source files. Use the sphinx-build script to build the docs, like so:
-''' % masterfile + (create_makefile and '''
- make <builder>
-''' or '''
- sphinx-build -b <builder> %s %s
-''' % (srcdir, builddir))
+source files. ''' % masterfile + (create_makefile and '''\
+Use the Makefile to build the docs, like so:
+ make builder
+''' or '''\
+Use the sphinx-build command to build the docs, like so:
+ sphinx-build -b builder %s %s
+''' % (srcdir, builddir)) + '''\
+where "builder" is one of the supported builders, e.g. html, latex or linkcheck.
+'''
def main(argv=sys.argv):