chore: testing docs and docfx

Author: chalmerlowe

packages/sqlalchemy-spanner/noxfile.py

@@ -412,82 +412,94 @@ def prerelease_deps(session):
 @nox.session(python="3.10")
 def docs(session):
     """Build the docs for this library."""
-
-    session.install("-e", ".")
-    session.install(
-        # We need to pin to specific versions of the `sphinxcontrib-*` packages
-        # which still support sphinx 4.x.
-        # See https://github.com/googleapis/sphinx-docfx-yaml/issues/344
-        # and https://github.com/googleapis/sphinx-docfx-yaml/issues/345.
-        "sphinxcontrib-applehelp==1.0.4",
-        "sphinxcontrib-devhelp==1.0.2",
-        "sphinxcontrib-htmlhelp==2.0.1",
-        "sphinxcontrib-qthelp==1.0.3",
-        "sphinxcontrib-serializinghtml==1.1.5",
-        "sphinx==4.5.0",
-        "alabaster",
-        "recommonmark",
-    )
-
-    shutil.rmtree(os.path.join("docs", "_build"), ignore_errors=True)
-    session.run(
-        "sphinx-build",
-        "-W",  # warnings as errors
-        "-T",  # show full traceback on exception
-        "-N",  # no colors
-        "-b",
-        "html",
-        "-d",
-        os.path.join("docs", "_build", "doctrees", ""),
-        os.path.join("docs", ""),
-        os.path.join("docs", "_build", "html", ""),
-    )
+    session.skip("docs builds are not yet supported")
 
 
 @nox.session(python="3.10")
 def docfx(session):
     """Build the docfx yaml files for this library."""
-
-    session.install("-e", ".")
-    session.install(
-        # We need to pin to specific versions of the `sphinxcontrib-*` packages
-        # which still support sphinx 4.x.
-        # See https://github.com/googleapis/sphinx-docfx-yaml/issues/344
-        # and https://github.com/googleapis/sphinx-docfx-yaml/issues/345.
-        "sphinxcontrib-applehelp==1.0.4",
-        "sphinxcontrib-devhelp==1.0.2",
-        "sphinxcontrib-htmlhelp==2.0.1",
-        "sphinxcontrib-qthelp==1.0.3",
-        "sphinxcontrib-serializinghtml==1.1.5",
-        "gcp-sphinx-docfx-yaml",
-        "alabaster",
-        "recommonmark",
-    )
-
-    shutil.rmtree(os.path.join("docs", "_build"), ignore_errors=True)
-    session.run(
-        "sphinx-build",
-        "-T",  # show full traceback on exception
-        "-N",  # no colors
-        "-D",
-        (
-            "extensions=sphinx.ext.autodoc,"
-            "sphinx.ext.autosummary,"
-            "docfx_yaml.extension,"
-            "sphinx.ext.intersphinx,"
-            "sphinx.ext.coverage,"
-            "sphinx.ext.napoleon,"
-            "sphinx.ext.todo,"
-            "sphinx.ext.viewcode,"
-            "recommonmark"
-        ),
-        "-b",
-        "html",
-        "-d",
-        os.path.join("docs", "_build", "doctrees", ""),
-        os.path.join("docs", ""),
-        os.path.join("docs", "_build", "html", ""),
-    )
+    session.skip("docfx builds are not yet supported")
+
+
+# @nox.session(python="3.10")
+# def docs(session):
+#     """Build the docs for this library."""
+
+#     session.install("-e", ".")
+#     session.install(
+#         # We need to pin to specific versions of the `sphinxcontrib-*` packages
+#         # which still support sphinx 4.x.
+#         # See https://github.com/googleapis/sphinx-docfx-yaml/issues/344
+#         # and https://github.com/googleapis/sphinx-docfx-yaml/issues/345.
+#         "sphinxcontrib-applehelp==1.0.4",
+#         "sphinxcontrib-devhelp==1.0.2",
+#         "sphinxcontrib-htmlhelp==2.0.1",
+#         "sphinxcontrib-qthelp==1.0.3",
+#         "sphinxcontrib-serializinghtml==1.1.5",
+#         "sphinx==4.5.0",
+#         "alabaster",
+#         "recommonmark",
+#     )
+
+#     shutil.rmtree(os.path.join("docs", "_build"), ignore_errors=True)
+#     session.run(
+#         "sphinx-build",
+#         "-W",  # warnings as errors
+#         "-T",  # show full traceback on exception
+#         "-N",  # no colors
+#         "-b",
+#         "html",
+#         "-d",
+#         os.path.join("docs", "_build", "doctrees", ""),
+#         os.path.join("docs", ""),
+#         os.path.join("docs", "_build", "html", ""),
+#     )
+
+
+# @nox.session(python="3.10")
+# def docfx(session):
+#     """Build the docfx yaml files for this library."""
+
+#     session.install("-e", ".")
+#     session.install(
+#         # We need to pin to specific versions of the `sphinxcontrib-*` packages
+#         # which still support sphinx 4.x.
+#         # See https://github.com/googleapis/sphinx-docfx-yaml/issues/344
+#         # and https://github.com/googleapis/sphinx-docfx-yaml/issues/345.
+#         "sphinxcontrib-applehelp==1.0.4",
+#         "sphinxcontrib-devhelp==1.0.2",
+#         "sphinxcontrib-htmlhelp==2.0.1",
+#         "sphinxcontrib-qthelp==1.0.3",
+#         "sphinxcontrib-serializinghtml==1.1.5",
+#         "gcp-sphinx-docfx-yaml",
+#         "alabaster",
+#         "recommonmark",
+#     )
+
+#     shutil.rmtree(os.path.join("docs", "_build"), ignore_errors=True)
+#     session.run(
+#         "sphinx-build",
+#         "-T",  # show full traceback on exception
+#         "-N",  # no colors
+#         "-D",
+#         (
+#             "extensions=sphinx.ext.autodoc,"
+#             "sphinx.ext.autosummary,"
+#             "docfx_yaml.extension,"
+#             "sphinx.ext.intersphinx,"
+#             "sphinx.ext.coverage,"
+#             "sphinx.ext.napoleon,"
+#             "sphinx.ext.todo,"
+#             "sphinx.ext.viewcode,"
+#             "recommonmark"
+#         ),
+#         "-b",
+#         "html",
+#         "-d",
+#         os.path.join("docs", "_build", "doctrees", ""),
+#         os.path.join("docs", ""),
+#         os.path.join("docs", "_build", "html", ""),
+#     )
 
 
 @nox.session