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
googleapis · Dec 24, 2020 · 3f026bf · 3f026bf
1 parent 6445693
commit 3f026bf
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 4 deletions.
diff --git a/docs/conf.py b/docs/conf.py
@@ -29,7 +29,7 @@
 # -- General configuration ------------------------------------------------
 
 # If your documentation needs a minimal Sphinx version, state it here.
-needs_sphinx = "1.6.3"
+needs_sphinx = "1.5.5"
 
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom

diff --git a/noxfile.py b/noxfile.py
@@ -173,7 +173,9 @@ def docfx(session):
     """Build the docfx yaml files for this library."""
 
     session.install("-e", ".")
-    session.install("sphinx", "alabaster", "recommonmark", "sphinx-docfx-yaml")
+    # sphinx-docfx-yaml supports up to sphinx version 1.5.5.
+    # https://github.com/docascode/sphinx-docfx-yaml/issues/97
+    session.install("sphinx==1.5.5", "alabaster", "recommonmark", "sphinx-docfx-yaml")
 
     shutil.rmtree(os.path.join("docs", "_build"), ignore_errors=True)
     session.run(

diff --git a/synth.metadata b/synth.metadata
@@ -19,14 +19,14 @@
       "git": {
         "name": "synthtool",
         "remote": "https://github.com/googleapis/synthtool.git",
-        "sha": "d302f93d7f47e2852e585ac35ab2d15585717ec0"
+        "sha": "ffcee7952b74f647cbb3ef021d95422f10816fca"
       }
     },
     {
       "git": {
         "name": "synthtool",
         "remote": "https://github.com/googleapis/synthtool.git",
-        "sha": "d302f93d7f47e2852e585ac35ab2d15585717ec0"
+        "sha": "ffcee7952b74f647cbb3ef021d95422f10816fca"
       }
     }
   ],