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

Merge pull request #5253 from tk0miya/enable_epub_by_default

Browse Source 
Enable epub by default
This commit is contained in:
Takeshi KOMIYA 2018-08-07 01:05:07 +09:00 committed by GitHub
commit b01256dbaf
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 2 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
CHANGES
View File

@ -55,6 +55,7 @@ Deprecated
---------- ----------
* :confval:`source_parsers` is deprecated * :confval:`source_parsers` is deprecated
* quickstart: ``--epub`` option becomes default, so it is deprecated
* Drop function based directive support. For now, Sphinx only supports class * Drop function based directive support. For now, Sphinx only supports class
based directives. based directives.
* ``sphinx.util.docutils.directive_helper()`` is deprecated * ``sphinx.util.docutils.directive_helper()`` is deprecated
@ -186,6 +187,7 @@ Features added
* #5140: linkcheck: Add better Accept header to HTTP client * #5140: linkcheck: Add better Accept header to HTTP client
* #4614: sphinx-build: Add ``--keep-going`` option to show all warnings * #4614: sphinx-build: Add ``--keep-going`` option to show all warnings
* Add :rst:role:`math:numref` role to refer equations (Same as :rst:role:`eq`) * Add :rst:role:`math:numref` role to refer equations (Same as :rst:role:`eq`)
* quickstart: epub builder is enabled by default
Bugs fixed Bugs fixed
---------- ----------

8
sphinx/cmd/quickstart.py
View File

@ -74,7 +74,6 @@ DEFAULTS = {
'language': None, 'language': None,
'suffix': '.rst', 'suffix': '.rst',
'master': 'index', 'master': 'index',
'epub': False,
'makefile': True, 'makefile': True,
'batchfile': True, 'batchfile': True,
} }
@ -246,7 +245,6 @@ def ask_user(d):
* language: document language * language: document language
* suffix: source file suffix * suffix: source file suffix
* master: master document name * master: master document name
* epub: use epub (bool)
* extensions: extensions to use (list) * extensions: extensions to use (list)
* makefile: make Makefile * makefile: make Makefile
* batchfile: make command file * batchfile: make command file
@ -347,12 +345,6 @@ document is a custom template, you can also set this to another filename.'''))
d['master'] = do_prompt(__('Please enter a new file name, or rename the ' d['master'] = do_prompt(__('Please enter a new file name, or rename the '
'existing file and press Enter'), d['master']) 'existing file and press Enter'), d['master'])
if 'epub' not in d:
print(__('''
Sphinx can also add configuration for epub output:'''))
d['epub'] = do_prompt(__('Do you want to use the epub builder (y/n)'),
'n', boolean)
if 'extensions' not in d: if 'extensions' not in d:
print(__('Indicate which of the following Sphinx extensions should be ' print(__('Indicate which of the following Sphinx extensions should be '
'enabled:')) 'enabled:'))

5
sphinx/templates/quickstart/conf.py_t
View File

@ -165,16 +165,12 @@ texinfo_documents = [
author, '{{ project_fn }}', 'One line description of project.', author, '{{ project_fn }}', 'One line description of project.',
'Miscellaneous'), 'Miscellaneous'),
] ]
{%- if epub %}
# -- Options for Epub output ------------------------------------------------- # -- Options for Epub output -------------------------------------------------
# Bibliographic Dublin Core info. # Bibliographic Dublin Core info.
epub_title = project epub_title = project
epub_author = author
epub_publisher = author
epub_copyright = copyright
# The unique identifier of the text. This can be a ISBN number # The unique identifier of the text. This can be a ISBN number
# or the project homepage. # or the project homepage.
@ -187,7 +183,6 @@ epub_copyright = copyright
# A list of files that should not be packed into the epub file. # A list of files that should not be packed into the epub file.
epub_exclude_files = ['search.html'] epub_exclude_files = ['search.html']
{%- endif %}
{%- if extensions %} {%- if extensions %}

1
tests/test_quickstart.py
View File

@ -197,7 +197,6 @@ def test_quickstart_all_answers(tempdir):
assert ns['latex_documents'] == [ assert ns['latex_documents'] == [
('contents', 'STASI.tex', u'STASI™ Documentation', ('contents', 'STASI.tex', u'STASI™ Documentation',
u'Wolfgang Schäuble \\& G\'Beckstein', 'manual')] u'Wolfgang Schäuble \\& G\'Beckstein', 'manual')]
assert ns['epub_author'] == u'Wolfgang Schäuble & G\'Beckstein'
assert ns['man_pages'] == [ assert ns['man_pages'] == [
('contents', 'stasi', u'STASI™ Documentation', ('contents', 'stasi', u'STASI™ Documentation',
[u'Wolfgang Schäuble & G\'Beckstein'], 1)] [u'Wolfgang Schäuble & G\'Beckstein'], 1)]