docs: Move bug directive

Bug: 386380020 Change-Id: I2696dcf119ad6f26d15aedd46915e6a7de63a344 Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/256693 Reviewed-by: Ted Pudlik <[email protected]> Docs-Not-Needed: Kayce Basques <[email protected]> Lint: Lint 🤖 <[email protected]> Commit-Queue: Auto-Submit <[email protected]> Pigweed-Auto-Submit: Kayce Basques <[email protected]> Presubmit-Verified: CQ Bot Account <[email protected]>
google · Jan 6, 2025 · bfe2c77 · bfe2c77
1 parent dbf07bb
commit bfe2c77
Show file tree

Hide file tree

Showing 6 changed files with 3 additions and 3 deletions.
diff --git a/docs/BUILD.bazel b/docs/BUILD.bazel
@@ -31,6 +31,7 @@ sphinx_docs_library(
     # TODO: https://pwbug.dev/377679855 - Rename this to "docs" after merging.
     name = "not_prefixed",
     srcs = [
+        "_extensions/bug.py",
         "_extensions/sitemap.py",
         "automated_analysis.rst",
         "bazel_compatibility.rst",

diff --git a/docs/BUILD.gn b/docs/BUILD.gn
@@ -40,6 +40,7 @@ pw_doc_group("core_docs") {
     "$dir_pw_build/py/pw_build/generate_python_wheel_cache.py",
     "$dir_pw_build/python.gni",
     "$dir_pw_build/python_gn_args.gni",
+    "_extensions/bug.py",
     "_extensions/sitemap.py",
     "layout/layout.html",
     "run_doxygen.py",

diff --git a/pw_docgen/py/pw_docgen/sphinx/bug.py → docs/_extensions/bug.py b/pw_docgen/py/pw_docgen/sphinx/bug.py → docs/_extensions/bug.py
diff --git a/docs/conf.py b/docs/conf.py
@@ -84,7 +84,7 @@ def pygments_monkeypatch_style(mod_name, cls):
     sys.path.append(f'{pw_root}/docs/_extensions')
 
 extensions = [
-    "pw_docgen.sphinx.bug",
+    "bug",  # Custom extension to normalize Pigweed bug links.
     "pw_docgen.sphinx.google_analytics",  # Enables optional Google Analytics
     "pw_docgen.sphinx.kconfig",
     "pw_docgen.sphinx.module_metadata",

diff --git a/pw_docgen/py/BUILD.bazel b/pw_docgen/py/BUILD.bazel
@@ -22,7 +22,6 @@ py_library(
     srcs = [
         "pw_docgen/__init__.py",
         "pw_docgen/sphinx/__init__.py",
-        "pw_docgen/sphinx/bug.py",
         "pw_docgen/sphinx/google_analytics.py",
         "pw_docgen/sphinx/kconfig.py",
         "pw_docgen/sphinx/module_metadata.py",

diff --git a/pw_docgen/py/BUILD.gn b/pw_docgen/py/BUILD.gn
@@ -27,7 +27,6 @@ pw_python_package("py") {
     "pw_docgen/docserver.py",
     "pw_docgen/seed.py",
     "pw_docgen/sphinx/__init__.py",
-    "pw_docgen/sphinx/bug.py",
     "pw_docgen/sphinx/google_analytics.py",
     "pw_docgen/sphinx/kconfig.py",
     "pw_docgen/sphinx/module_metadata.py",