Skip to content

Commit 71b8a27

Browse files
authored
docs: update python docs template (#576)
* docs: update python docs template * sphinx change
1 parent 470789c commit 71b8a27

File tree

2 files changed

+2
-5
lines changed

2 files changed

+2
-5
lines changed

synthtool/gcp/templates/python_library/docs/conf.py.j2

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,7 @@ extensions = [
3838
"sphinx.ext.napoleon",
3939
"sphinx.ext.todo",
4040
"sphinx.ext.viewcode",
41+
"recommonmark",
4142
]
4243

4344
# autodoc/autosummary flags
@@ -49,10 +50,6 @@ autosummary_generate = True
4950
# Add any paths that contain templates here, relative to this directory.
5051
templates_path = ["_templates"]
5152

52-
# Allow markdown includes (so releases.md can include CHANGLEOG.md)
53-
# http://www.sphinx-doc.org/en/master/markdown.html
54-
source_parsers = {".md": "recommonmark.parser.CommonMarkParser"}
55-
5653
# The suffix(es) of source filenames.
5754
# You can specify multiple suffix as a list of string:
5855
# source_suffix = ['.rst', '.md']

synthtool/gcp/templates/python_library/noxfile.py.j2

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -166,7 +166,7 @@ def docs(session):
166166
"""Build the docs for this library."""
167167

168168
session.install('-e', '.')
169-
session.install('sphinx<3.0.0', 'alabaster', 'recommonmark')
169+
session.install('sphinx', 'alabaster', 'recommonmark')
170170

171171
shutil.rmtree(os.path.join('docs', '_build'), ignore_errors=True)
172172
session.run(

0 commit comments

Comments
 (0)