docs: rename sphinx plugin to sphinx_bzl (#1922)
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
index c2a1690..f82d43a 100644
--- a/docs/sphinx/BUILD.bazel
+++ b/docs/sphinx/BUILD.bazel
@@ -123,7 +123,7 @@
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
index fef083c..b315577 100644
--- 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_stardoc/BUILD.bazel b/sphinxdocs/src/sphinx_bzl/BUILD.bazel
similarity index 91%
rename from sphinxdocs/src/sphinx_stardoc/BUILD.bazel
rename to sphinxdocs/src/sphinx_bzl/BUILD.bazel
index b788b09..8830315 100644
--- a/sphinxdocs/src/sphinx_stardoc/BUILD.bazel
+++ b/sphinxdocs/src/sphinx_bzl/BUILD.bazel
@@ -6,7 +6,7 @@
# 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_stardoc/__init__.py b/sphinxdocs/src/sphinx_bzl/__init__.py
similarity index 100%
rename from sphinxdocs/src/sphinx_stardoc/__init__.py
rename to sphinxdocs/src/sphinx_bzl/__init__.py
diff --git a/sphinxdocs/src/sphinx_stardoc/stardoc.py b/sphinxdocs/src/sphinx_bzl/bzl.py
similarity index 100%
rename from sphinxdocs/src/sphinx_stardoc/stardoc.py
rename to sphinxdocs/src/sphinx_bzl/bzl.py
diff --git a/sphinxdocs/tests/sphinx_stardoc/BUILD.bazel b/sphinxdocs/tests/sphinx_stardoc/BUILD.bazel
index 63e34fb..b03561b 100644
--- a/sphinxdocs/tests/sphinx_stardoc/BUILD.bazel
+++ b/sphinxdocs/tests/sphinx_stardoc/BUILD.bazel
@@ -56,7 +56,7 @@
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
index b1dae97..bc288b0 100644
--- 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",
]