Question

当我运行sphinx-quickstart

时

显示这些选项对我来说太烦人了

我可以使用默认配置吗？没有逐一检查这些选项？

Please indicate if you want to use one of the following Sphinx extensions:
> autodoc: automatically insert docstrings from modules (y/n) [n]:
> doctest: automatically test code snippets in doctest blocks (y/n) [n]:
> intersphinx: link between Sphinx documentation of different projects (y/n) [n]:
> todo: write "todo" entries that can be shown or hidden on build (y/n) [n]:
> coverage: checks for documentation coverage (y/n) [n]:
> pngmath: include math, rendered as PNG images (y/n) [n]:
> mathjax: include math, rendered in the browser by MathJax (y/n) [n]:
> ifconfig: conditional inclusion of content based on config values (y/n) [n]:
> viewcode: include links to the source code of documented Python objects (y/n) [n]:

Answer 1

基本上，您应该考虑的是编写自己的脚本，这将按照您希望的方式放置所有内容，并且在此过程中不会向您提出任何问题。 sphinx-quickstart是一个通用实用程序，应该允许某种程度的自定义。它也是对初学者用户的驱动，他们不熟悉项目结构，如果你知道把所有东西都放在哪里，你可以在没有sphinx-quickstart的情况下生活。在我工作的项目中，我通常最终为大多数操作（init，build，deploy等）创建自己的Python / Bash脚本。希望它有所帮助。

Answer 2

我使用自定义脚本（自定义快速入门）将默认配置传递给生成函数：

# -*- coding: utf-8 -*-

import re
import sys

from sphinx.quickstart import generate, do_prompt
if __name__ == '__main__':
    sys.argv[0] = re.sub(r'(-script\.pyw|\.exe)?$', '', sys.argv[0])
    d= {
        'path': '.',
        'sep': True,
        'dot': '_',
        'author': 'C. Brun',
        'version': '1.0',
        'release': '1.0',
        'suffix': '.rst',
        'master': 'index',
        'epub': False,
        'ext_autodoc': False,
        'ext_doctest': False,
        'ext_intersphinx': False,
        'ext_todo': False,
        'ext_coverage': False,
        'ext_pngmath': False,
        'ext_mathiax': False,
        'ext_ifconfig': True,
        'ext_todo': True,
        'ext_viewcode': False,
        'makefile': True,
        'batchfile': False,
    }
    if 'project' not in d:
        print '''
            Nom du projet
        '''
        do_prompt(d, 'project', 'Project Name')
    generate(d)

如何自定义sphinx-quickstart的配置

2 个答案: