docs: rename sphinx plugin to sphinx_bzl (bazel-contrib#1922)

rickeylev · web-flow · commit 975edfe87c44 · 2024-05-25T04:52:43.000Z
This is to better reflect its Sphinx domain name and the scope of what
it covers. It is able to document general Bazel concepts and isn't
actually tied to Stardoc itself.
diff --git a/docs/sphinx/BUILD.bazel b/docs/sphinx/BUILD.bazel
@@ -123,7 +123,7 @@ sphinx_build_binary(
         requirement("myst_parser"),
         requirement("readthedocs_sphinx_ext"),
         requirement("typing_extensions"),
-        "//sphinxdocs/src/sphinx_stardoc",
+        "//sphinxdocs/src/sphinx_bzl",
     ],
 )
 
diff --git a/docs/sphinx/conf.py b/docs/sphinx/conf.py
@@ -27,7 +27,7 @@
     "sphinx.ext.intersphinx",
     "myst_parser",
     "sphinx_rtd_theme",  # Necessary to get jquery to make flyout work
-    "sphinx_stardoc.stardoc",
+    "sphinx_bzl.bzl",
 ]
 
 # Adapted from the template code:
diff --git a/sphinxdocs/src/sphinx_bzl/BUILD.bazel b/sphinxdocs/src/sphinx_bzl/BUILD.bazel
@@ -6,7 +6,7 @@ package(
 
 # NOTE: This provides the library on its own, not its dependencies.
 py_library(
-    name = "sphinx_stardoc",
+    name = "sphinx_bzl",
     srcs = glob(["*.py"]),
     imports = [".."],
     # Allow depending on it in sphinx_binary targets
diff --git a/sphinxdocs/src/sphinx_bzl/__init__.py b/sphinxdocs/src/sphinx_bzl/__init__.py
diff --git a/sphinxdocs/src/sphinx_bzl/bzl.py b/sphinxdocs/src/sphinx_bzl/bzl.py
diff --git a/sphinxdocs/tests/sphinx_stardoc/BUILD.bazel b/sphinxdocs/tests/sphinx_stardoc/BUILD.bazel
@@ -56,7 +56,7 @@ sphinx_build_binary(
     name = "sphinx-build",
     tags = ["manual"],  # Only needed as part of sphinx doc building
     deps = [
-        "//sphinxdocs/src/sphinx_stardoc",
+        "//sphinxdocs/src/sphinx_bzl",
         "@dev_pip//myst_parser",
         "@dev_pip//sphinx",
         "@dev_pip//typing_extensions",  # Needed by sphinx_stardoc
diff --git a/sphinxdocs/tests/sphinx_stardoc/conf.py b/sphinxdocs/tests/sphinx_stardoc/conf.py
@@ -8,7 +8,7 @@
 project = "Sphinx Stardoc Test"
 
 extensions = [
-    "sphinx_stardoc.stardoc",
+    "sphinx_bzl.bzl",
     "myst_parser",
     "sphinx.ext.intersphinx",
 ]

Original file line number	Diff line number	Diff line change
`@@ -123,7 +123,7 @@ sphinx_build_binary(`
`123`	`123`	`requirement("myst_parser"),`
`124`	`124`	`requirement("readthedocs_sphinx_ext"),`
`125`	`125`	`requirement("typing_extensions"),`
`126`		`- "//sphinxdocs/src/sphinx_stardoc",`
	`126`	`+ "//sphinxdocs/src/sphinx_bzl",`
`127`	`127`	`],`
`128`	`128`	`)`
`129`	`129`
Original file line number	Diff line number	Diff line change
`@@ -27,7 +27,7 @@`
`27`	`27`	`"sphinx.ext.intersphinx",`
`28`	`28`	`"myst_parser",`
`29`	`29`	`"sphinx_rtd_theme", # Necessary to get jquery to make flyout work`
`30`		`- "sphinx_stardoc.stardoc",`
	`30`	`+ "sphinx_bzl.bzl",`
`31`	`31`	`]`
`32`	`32`
`33`	`33`	`# Adapted from the template code:`
Original file line number	Diff line number	Diff line change
`@@ -8,7 +8,7 @@`
`8`	`8`	`project = "Sphinx Stardoc Test"`
`9`	`9`
`10`	`10`	`extensions = [`
`11`		`- "sphinx_stardoc.stardoc",`
	`11`	`+ "sphinx_bzl.bzl",`
`12`	`12`	`"myst_parser",`
`13`	`13`	`"sphinx.ext.intersphinx",`
`14`	`14`	`]`