fix: fix docs build for generated clients (#1715)

googleapis · Aug 3, 2023 · e4db994 · e4db994
1 parent 09b54dd
commit e4db994
Show file tree

Hide file tree

Showing 20 changed files with 28 additions and 13 deletions.
diff --git a/gapic/ads-templates/docs/_static/custom.css → .../ads-templates/docs/_static/custom.css.j2 b/gapic/ads-templates/docs/_static/custom.css → .../ads-templates/docs/_static/custom.css.j2
diff --git a/gapic/ads-templates/docs/conf.py.j2 b/gapic/ads-templates/docs/conf.py.j2
@@ -85,7 +85,7 @@ version = ".".join(release.split(".")[0:2])
 #
 # This is also used if you do content translation via gettext catalogs.
 # Usually you set "language" from the command line for these cases.
-language = None
+language = 'en'
 
 # There are two options for replacing |today|: either, you set today to some
 # non-false value, then it is used:

diff --git a/gapic/templates/docs/_static/custom.css → gapic/templates/docs/_static/custom.css.j2 b/gapic/templates/docs/_static/custom.css → gapic/templates/docs/_static/custom.css.j2
diff --git a/gapic/templates/docs/conf.py.j2 b/gapic/templates/docs/conf.py.j2
@@ -85,7 +85,7 @@ version = ".".join(release.split(".")[0:2])
 #
 # This is also used if you do content translation via gettext catalogs.
 # Usually you set "language" from the command line for these cases.
-language = None
+language = 'en'
 
 # There are two options for replacing |today|: either, you set today to some
 # non-false value, then it is used:

diff --git a/gapic/templates/noxfile.py.j2 b/gapic/templates/noxfile.py.j2
@@ -127,7 +127,7 @@ def docs(session):
     """Build the docs for this library."""
 
     session.install("-e", ".")
-    session.install("sphinx==4.0.1", "alabaster", "recommonmark")
+    session.install("sphinx==7.0.1", "alabaster", "recommonmark")
 
     shutil.rmtree(os.path.join("docs", "_build"), ignore_errors=True)
     session.run(

diff --git a/tests/integration/goldens/asset/docs/_static/custom.css b/tests/integration/goldens/asset/docs/_static/custom.css
@@ -0,0 +1,3 @@
+dl.field-list > dt {
+    min-width: 100px
+}
diff --git a/tests/integration/goldens/asset/docs/conf.py b/tests/integration/goldens/asset/docs/conf.py
@@ -96,7 +96,7 @@
 #
 # This is also used if you do content translation via gettext catalogs.
 # Usually you set "language" from the command line for these cases.
-language = None
+language = 'en'
 
 # There are two options for replacing |today|: either, you set today to some
 # non-false value, then it is used:

diff --git a/tests/integration/goldens/asset/noxfile.py b/tests/integration/goldens/asset/noxfile.py
@@ -134,7 +134,7 @@ def docs(session):
     """Build the docs for this library."""
 
     session.install("-e", ".")
-    session.install("sphinx==4.0.1", "alabaster", "recommonmark")
+    session.install("sphinx==7.0.1", "alabaster", "recommonmark")
 
     shutil.rmtree(os.path.join("docs", "_build"), ignore_errors=True)
     session.run(

diff --git a/tests/integration/goldens/credentials/docs/_static/custom.css b/tests/integration/goldens/credentials/docs/_static/custom.css
@@ -0,0 +1,3 @@
+dl.field-list > dt {
+    min-width: 100px
+}
diff --git a/tests/integration/goldens/credentials/docs/conf.py b/tests/integration/goldens/credentials/docs/conf.py
@@ -96,7 +96,7 @@
 #
 # This is also used if you do content translation via gettext catalogs.
 # Usually you set "language" from the command line for these cases.
-language = None
+language = 'en'
 
 # There are two options for replacing |today|: either, you set today to some
 # non-false value, then it is used:

diff --git a/tests/integration/goldens/credentials/noxfile.py b/tests/integration/goldens/credentials/noxfile.py
@@ -134,7 +134,7 @@ def docs(session):
     """Build the docs for this library."""
 
     session.install("-e", ".")
-    session.install("sphinx==4.0.1", "alabaster", "recommonmark")
+    session.install("sphinx==7.0.1", "alabaster", "recommonmark")
 
     shutil.rmtree(os.path.join("docs", "_build"), ignore_errors=True)
     session.run(

diff --git a/tests/integration/goldens/eventarc/docs/_static/custom.css b/tests/integration/goldens/eventarc/docs/_static/custom.css
@@ -0,0 +1,3 @@
+dl.field-list > dt {
+    min-width: 100px
+}
diff --git a/tests/integration/goldens/eventarc/docs/conf.py b/tests/integration/goldens/eventarc/docs/conf.py
@@ -96,7 +96,7 @@
 #
 # This is also used if you do content translation via gettext catalogs.
 # Usually you set "language" from the command line for these cases.
-language = None
+language = 'en'
 
 # There are two options for replacing |today|: either, you set today to some
 # non-false value, then it is used:

diff --git a/tests/integration/goldens/eventarc/noxfile.py b/tests/integration/goldens/eventarc/noxfile.py
@@ -134,7 +134,7 @@ def docs(session):
     """Build the docs for this library."""
 
     session.install("-e", ".")
-    session.install("sphinx==4.0.1", "alabaster", "recommonmark")
+    session.install("sphinx==7.0.1", "alabaster", "recommonmark")
 
     shutil.rmtree(os.path.join("docs", "_build"), ignore_errors=True)
     session.run(

diff --git a/tests/integration/goldens/logging/docs/_static/custom.css b/tests/integration/goldens/logging/docs/_static/custom.css
@@ -0,0 +1,3 @@
+dl.field-list > dt {
+    min-width: 100px
+}
diff --git a/tests/integration/goldens/logging/docs/conf.py b/tests/integration/goldens/logging/docs/conf.py
@@ -96,7 +96,7 @@
 #
 # This is also used if you do content translation via gettext catalogs.
 # Usually you set "language" from the command line for these cases.
-language = None
+language = 'en'
 
 # There are two options for replacing |today|: either, you set today to some
 # non-false value, then it is used:

diff --git a/tests/integration/goldens/logging/noxfile.py b/tests/integration/goldens/logging/noxfile.py
@@ -134,7 +134,7 @@ def docs(session):
     """Build the docs for this library."""
 
     session.install("-e", ".")
-    session.install("sphinx==4.0.1", "alabaster", "recommonmark")
+    session.install("sphinx==7.0.1", "alabaster", "recommonmark")
 
     shutil.rmtree(os.path.join("docs", "_build"), ignore_errors=True)
     session.run(

diff --git a/tests/integration/goldens/redis/docs/_static/custom.css b/tests/integration/goldens/redis/docs/_static/custom.css
@@ -0,0 +1,3 @@
+dl.field-list > dt {
+    min-width: 100px
+}
diff --git a/tests/integration/goldens/redis/docs/conf.py b/tests/integration/goldens/redis/docs/conf.py
@@ -96,7 +96,7 @@
 #
 # This is also used if you do content translation via gettext catalogs.
 # Usually you set "language" from the command line for these cases.
-language = None
+language = 'en'
 
 # There are two options for replacing |today|: either, you set today to some
 # non-false value, then it is used:

diff --git a/tests/integration/goldens/redis/noxfile.py b/tests/integration/goldens/redis/noxfile.py
@@ -134,7 +134,7 @@ def docs(session):
     """Build the docs for this library."""
 
     session.install("-e", ".")
-    session.install("sphinx==4.0.1", "alabaster", "recommonmark")
+    session.install("sphinx==7.0.1", "alabaster", "recommonmark")
 
     shutil.rmtree(os.path.join("docs", "_build"), ignore_errors=True)
     session.run(