Skip to content

Commit 3ba4642

Browse files
chore(python-library): use sphinx 1.5.5 for the docfx job
Originally tested at: googleapis/python-texttospeech#89 This change will fix the missing docstring in the yaml files. Source-Author: Takashi Matsuo <[email protected]> Source-Date: Thu Sep 10 04:12:14 2020 +0000 Source-Repo: googleapis/synthtool Source-Sha: ffcee7952b74f647cbb3ef021d95422f10816fca Source-Link: googleapis/synthtool@ffcee79
1 parent 238b295 commit 3ba4642

File tree

3 files changed

+5
-3
lines changed

3 files changed

+5
-3
lines changed

docs/conf.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@
2929
# -- General configuration ------------------------------------------------
3030

3131
# If your documentation needs a minimal Sphinx version, state it here.
32-
needs_sphinx = "1.6.3"
32+
needs_sphinx = "1.5.5"
3333

3434
# Add any Sphinx extension module names here, as strings. They can be
3535
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom

noxfile.py

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -176,7 +176,9 @@ def docfx(session):
176176
"""Build the docfx yaml files for this library."""
177177

178178
session.install("-e", ".")
179-
session.install("sphinx", "alabaster", "recommonmark", "sphinx-docfx-yaml")
179+
# sphinx-docfx-yaml supports up to sphinx version 1.5.5.
180+
# https://github.com/docascode/sphinx-docfx-yaml/issues/97
181+
session.install("sphinx==1.5.5", "alabaster", "recommonmark", "sphinx-docfx-yaml")
180182

181183
shutil.rmtree(os.path.join("docs", "_build"), ignore_errors=True)
182184
session.run(

synth.metadata

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
"git": {
1212
"name": "synthtool",
1313
"remote": "https://github.com/googleapis/synthtool.git",
14-
"sha": "d302f93d7f47e2852e585ac35ab2d15585717ec0"
14+
"sha": "ffcee7952b74f647cbb3ef021d95422f10816fca"
1515
}
1616
}
1717
],

0 commit comments

Comments
 (0)