diff options
| author | Takeshi KOMIYA <i.tkomiya@gmail.com> | 2018-12-02 01:30:51 +0900 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2018-12-02 01:30:51 +0900 |
| commit | e527be396a761a8d3a2c8788d766363a01bc1810 (patch) | |
| tree | d4e8316f720ff12d31e70b67faf9ec0c7ecf0ee7 /sphinx/builders/texinfo.py | |
| parent | 1b039614bc0355a5f884f7c338ca45ceb6de0bc8 (diff) | |
| parent | b2f069ba6e5740824500ba62df38dd2996fa22a0 (diff) | |
| download | sphinx-git-e527be396a761a8d3a2c8788d766363a01bc1810.tar.gz | |
Merge pull request #5607 from tk0miya/smart_texinfo_conf_py
quickstart: Simplify generated conf.py (for texinfo)
Diffstat (limited to 'sphinx/builders/texinfo.py')
| -rw-r--r-- | sphinx/builders/texinfo.py | 19 |
1 files changed, 11 insertions, 8 deletions
diff --git a/sphinx/builders/texinfo.py b/sphinx/builders/texinfo.py index f5397ecd6..82a1b8f3d 100644 --- a/sphinx/builders/texinfo.py +++ b/sphinx/builders/texinfo.py @@ -28,12 +28,13 @@ from sphinx.util.console import bold, darkgreen # type: ignore from sphinx.util.docutils import new_document from sphinx.util.fileutil import copy_asset_file from sphinx.util.nodes import inline_all_toctrees -from sphinx.util.osutil import SEP, make_filename +from sphinx.util.osutil import SEP, make_filename_from_project from sphinx.writers.texinfo import TexinfoWriter, TexinfoTranslator if False: # For type annotation from sphinx.application import Sphinx # NOQA + from sphinx.config import Config # NOQA from typing import Any, Dict, Iterable, List, Tuple, Union # NOQA from sphinx.util.typing import unicode # NOQA @@ -210,17 +211,19 @@ class TexinfoBuilder(Builder): path.join(self.srcdir, src), err) +def default_texinfo_documents(config): + # type: (Config) -> List[Tuple[unicode, unicode, unicode, unicode, unicode, unicode, unicode]] # NOQA + """ Better default texinfo_documents settings. """ + filename = make_filename_from_project(config.project) + return [(config.master_doc, filename, config.project, config.author, filename, + 'One line description of project', 'Miscellaneous')] + + def setup(app): # type: (Sphinx) -> Dict[unicode, Any] app.add_builder(TexinfoBuilder) - app.add_config_value('texinfo_documents', - lambda self: [(self.master_doc, make_filename(self.project).lower(), - self.project, '', make_filename(self.project), - 'The %s reference manual.' % - make_filename(self.project), - 'Python')], - None) + app.add_config_value('texinfo_documents', default_texinfo_documents, None) app.add_config_value('texinfo_appendices', [], None) app.add_config_value('texinfo_elements', {}, None) app.add_config_value('texinfo_domain_indices', True, None, [list]) |
