diff --git a/CHANGES b/CHANGES index fad26e5362..ab59e51a86 100644 --- a/CHANGES +++ b/CHANGES @@ -20,6 +20,8 @@ Features added directives through a new ``option_emphasise_placeholders`` configuration option. * #10439: std domain: Use the repr of some variables when displaying warnings, making whitespace issues easier to identify. +* #10571: quickstart: Reduce content in the generated ``conf.py`` file. Patch by + Pradyun Gedam. Bugs fixed ---------- diff --git a/sphinx/templates/quickstart/conf.py_t b/sphinx/templates/quickstart/conf.py_t index 07a1aa8675..3836486753 100644 --- a/sphinx/templates/quickstart/conf.py_t +++ b/sphinx/templates/quickstart/conf.py_t @@ -1,30 +1,18 @@ # Configuration file for the Sphinx documentation builder. # -# This file only contains a selection of the most common options. For a full -# list see the documentation: +# For the full list of built-in configuration values, see the documentation: # https://www.sphinx-doc.org/en/master/usage/configuration.html +{% if append_syspath -%} # -- Path setup -------------------------------------------------------------- -# If extensions (or modules to document with autodoc) are in another directory, -# add these directories to sys.path here. If the directory is relative to the -# documentation root, use os.path.abspath to make it absolute, like shown here. -# -{% if append_syspath -%} import os import sys sys.path.insert(0, {{ module_path | repr }}) -{% else -%} -# import os -# import sys -{% if module_path -%} -# sys.path.insert(0, {{ module_path | repr }}) -{% else -%} -# sys.path.insert(0, os.path.abspath('.')) -{% endif -%} -{% endif %} +{% endif -%} # -- Project information ----------------------------------------------------- +# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information project = {{ project | repr }} copyright = {{ copyright | repr }} @@ -32,88 +20,52 @@ author = {{ author | repr }} {%- if version %} -# The short X.Y version version = {{ version | repr }} {%- endif %} {%- if release %} - -# The full version, including alpha/beta/rc tags release = {{ release | repr }} {%- endif %} - # -- General configuration --------------------------------------------------- +# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration -# Add any Sphinx extension module names here, as strings. They can be -# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom -# ones. -extensions = [ +extensions = [{% if extensions %} {%- for ext in extensions %} '{{ ext }}', {%- endfor %} -] +{% endif %}] -# Add any paths that contain templates here, relative to this directory. templates_path = ['{{ dot }}templates'] +exclude_patterns = [{{ exclude_patterns }}] {% if suffix != '.rst' -%} -# The suffix(es) of source filenames. -# You can specify multiple suffix as a list of string: -# -# source_suffix = ['.rst', '.md'] source_suffix = {{ suffix | repr }} - {% endif -%} + {% if root_doc != 'index' -%} -# The root document. root_doc = {{ root_doc | repr }} - {% endif -%} + {% if language -%} -# The language for content autogenerated by Sphinx. Refer to documentation -# for a list of supported languages. -# -# This is also used if you do content translation via gettext catalogs. -# Usually you set "language" from the command line for these cases. language = {{ language | repr }} - -{% endif -%} -# List of patterns, relative to source directory, that match files and -# directories to ignore when looking for source files. -# This pattern also affects html_static_path and html_extra_path. -exclude_patterns = [{{ exclude_patterns }}] - +{%- endif %} # -- Options for HTML output ------------------------------------------------- +# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output -# The theme to use for HTML and HTML Help pages. See the documentation for -# a list of builtin themes. -# html_theme = 'alabaster' - -# Add any paths that contain custom static files (such as style sheets) here, -# relative to this directory. They are copied after the builtin static files, -# so a file named "default.css" will overwrite the builtin "default.css". html_static_path = ['{{ dot }}static'] -{%- if extensions %} - - -# -- Extension configuration ------------------------------------------------- -{%- endif %} -{%- if 'sphinx.ext.intersphinx' in extensions %} - +{% if 'sphinx.ext.intersphinx' in extensions %} # -- Options for intersphinx extension --------------------------------------- +# https://www.sphinx-doc.org/en/master/usage/extensions/intersphinx.html#configuration -# Example configuration for intersphinx: refer to the Python standard library. intersphinx_mapping = { 'python': ('https://docs.python.org/3', None), } - -{%- endif %} -{%- if 'sphinx.ext.todo' in extensions %} - +{% endif -%} +{% if 'sphinx.ext.todo' in extensions %} # -- Options for todo extension ---------------------------------------------- +# https://www.sphinx-doc.org/en/master/usage/extensions/todo.html#configuration -# If true, `todo` and `todoList` produce output, else they produce nothing. todo_include_todos = True -{%- endif %} +{% endif %}