Skip to content

Commit f83a288

Browse files
committed
🤝 sync with sphinx doc templates
1 parent eedde0f commit f83a288

File tree

3 files changed

+11
-22
lines changed

3 files changed

+11
-22
lines changed

templates/docs/conf.py_t

Lines changed: 11 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -30,10 +30,16 @@ project = {{ project | repr }}
3030
copyright = {{ copyright | repr }}
3131
author = {{ author | repr }}
3232

33+
{%- if version %}
34+
3335
# The short X.Y version
3436
version = {{ version | repr }}
37+
{%- endif %}
38+
{%- if release %}
39+
3540
# The full version, including alpha/beta/rc tags
3641
release = {{ release | repr }}
42+
{%- endif %}
3743

3844

3945
# -- General configuration ---------------------------------------------------
@@ -50,24 +56,28 @@ extensions = [
5056
# Add any paths that contain templates here, relative to this directory.
5157
templates_path = ['{{ dot }}templates']
5258

59+
{% if suffix != '.rst' -%}
5360
# The suffix(es) of source filenames.
5461
# You can specify multiple suffix as a list of string:
5562
#
5663
# source_suffix = ['.rst', '.md']
5764
source_suffix = {{ suffix | repr }}
5865

59-
{% if master_doc != 'index' -%}
66+
{% endif -%}
67+
{% if master != 'index' -%}
6068
# The master toctree document.
6169
master_doc = {{ master | repr }}
6270

6371
{% endif -%}
72+
{% if language -%}
6473
# The language for content autogenerated by Sphinx. Refer to documentation
6574
# for a list of supported languages.
6675
#
6776
# This is also used if you do content translation via gettext catalogs.
6877
# Usually you set "language" from the command line for these cases.
6978
language = {{ language | repr }}
7079

80+
{% endif -%}
7181
# List of patterns, relative to source directory, that match files and
7282
# directories to ignore when looking for source files.
7383
# This pattern also affects html_static_path and html_extra_path.
@@ -101,24 +111,6 @@ html_static_path = ['{{ dot }}static']
101111
# 'searchbox.html']``.
102112
#
103113
# html_sidebars = {}
104-
105-
106-
# -- Options for Epub output -------------------------------------------------
107-
108-
# Bibliographic Dublin Core info.
109-
epub_title = project
110-
111-
# The unique identifier of the text. This can be a ISBN number
112-
# or the project homepage.
113-
#
114-
# epub_identifier = ''
115-
116-
# A unique identification for the text.
117-
#
118-
# epub_uid = ''
119-
120-
# A list of files that should not be packed into the epub file.
121-
epub_exclude_files = ['search.html']
122114
{%- if extensions %}
123115

124116

@@ -138,4 +130,3 @@ intersphinx_mapping = {'https://docs.python.org/': None}
138130
# If true, `todo` and `todoList` produce output, else they produce nothing.
139131
todo_include_todos = True
140132
{%- endif %}
141-

templates/docs/make.bat.jj2

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,4 +33,3 @@ goto end
3333

3434
:end
3535
popd
36-

templates/docs/master_doc.rst_t

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,4 +18,3 @@ Indices and tables
1818
* :ref:`genindex`
1919
* :ref:`modindex`
2020
* :ref:`search`
21-

0 commit comments

Comments
 (0)