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

Fix #103: add all (usable) builtin extensions to quickstart.

Browse Source
This commit is contained in:
Georg Brandl 2009-02-20 10:43:56 +01:00
parent db8f428414
commit 5b1415d16a
2 changed files with 18 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
sphinx/quickstart.py
View File

@ -589,6 +589,17 @@ Please indicate if you want to use one of the following Sphinx extensions:'''
'in doctest blocks (y/N)', 'n', boolean) 'in doctest blocks (y/N)', 'n', boolean)
do_prompt(d, 'ext_intersphinx', 'intersphinx: link between Sphinx ' do_prompt(d, 'ext_intersphinx', 'intersphinx: link between Sphinx '
'documentation of different projects (y/N)', 'n', boolean) 'documentation of different projects (y/N)', 'n', boolean)
do_prompt(d, 'ext_todo', 'todo: write "todo" entries '
'that can be shown or hidden on build (y/N)', 'n', boolean)
do_prompt(d, 'ext_coverage', 'coverage: checks for documentation '
'coverage (y/N)', 'n', boolean)
do_prompt(d, 'ext_pngmath', 'pngmath: include math, rendered '
'as PNG images (y/N)', 'n', boolean)
do_prompt(d, 'ext_jsmath', 'jsmath: include math, rendered in the '
'browser by JSMath (y/N)', 'n', boolean)
if d['ext_pngmath'] and d['ext_jsmath']:
print '''Note: pngmath and jsmath cannot be enabled at the same time.
pngmath has been deselected.'''
print ''' print '''
A Makefile and a Windows command file can be generated for you so that you A Makefile and a Windows command file can be generated for you so that you
only have to run e.g. `make html' instead of invoking sphinx-build only have to run e.g. `make html' instead of invoking sphinx-build
@ -601,8 +612,9 @@ directly.'''
d['now'] = time.asctime() d['now'] = time.asctime()
d['underline'] = len(d['project']) * '=' d['underline'] = len(d['project']) * '='
d['extensions'] = ', '.join( d['extensions'] = ', '.join(
repr('sphinx.ext.' + name) for name in ('autodoc', 'doctest', repr('sphinx.ext.' + name)
'intersphinx') for name in ('autodoc', 'doctest', 'intersphinx', 'todo', 'coverage',
'pngmath', 'jsmath')
if d['ext_' + name].upper() in ('Y', 'YES')) if d['ext_' + name].upper() in ('Y', 'YES'))
d['copyright'] = time.strftime('%Y') + ', ' + d['author'] d['copyright'] = time.strftime('%Y') + ', ' + d['author']
d['author_texescaped'] = unicode(d['author']).\ d['author_texescaped'] = unicode(d['author']).\

4
tests/test_quickstart.py
View File

@ -121,6 +121,10 @@ def test_quickstart_all_answers(tempdir):
'autodoc': 'y', 'autodoc': 'y',
'doctest': 'yes', 'doctest': 'yes',
'intersphinx': 'no', 'intersphinx': 'no',
'todo': 'n',
'coverage': 'no',
'pngmath': 'N',
'jsmath': 'no',
'Create Makefile': 'no', 'Create Makefile': 'no',
'Create Windows command file': 'no', 'Create Windows command file': 'no',
} }