Skip to content

Commit 11bab4a

Browse files
committed
Fix doc build for recent versions of sphinx.
1 parent 40f2491 commit 11bab4a

File tree

3 files changed

+8
-4
lines changed

3 files changed

+8
-4
lines changed

docs/.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
_generate/*

docs/conf.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@
4040
# The suffix(es) of source filenames.
4141
# You can specify multiple suffix as a list of string:
4242
# source_suffix = ['.rst', '.md']
43-
source_suffix = ".rst"
43+
source_suffix = {".rst": "restructuredtext"}
4444

4545
# The encoding of source files.
4646
# source_encoding = 'utf-8-sig'
@@ -67,7 +67,7 @@
6767
#
6868
# This is also used if you do content translation via gettext catalogs.
6969
# Usually you set "language" from the command line for these cases.
70-
language = None
70+
language = "en"
7171

7272
# There are two options for replacing |today|: either, you set today to some
7373
# non-false value, then it is used:
@@ -140,7 +140,7 @@
140140
# Add any paths that contain custom static files (such as style sheets) here,
141141
# relative to this directory. They are copied after the builtin static files,
142142
# so a file named "default.css" will overwrite the builtin "default.css".
143-
html_static_path = ["_static"]
143+
# html_static_path = ["_static"]
144144

145145
# Add any extra paths that contain custom files (such as robots.txt or
146146
# .htaccess) here, relative to this directory. These files are copied
@@ -295,4 +295,4 @@
295295

296296

297297
# Example configuration for intersphinx: refer to the Python standard library.
298-
intersphinx_mapping = {"https://docs.python.org/": None}
298+
intersphinx_mapping = {"python": ("https://docs.python.org/", None)}

docs/python_example.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,4 @@
1+
The python_example module
2+
=========================
3+
14
.. automodule:: python_example

0 commit comments

Comments
 (0)