Renaming 'docs-as-code' => 'score_docs_as_code' (#10)

Author: MaximilianSoerenPollak

README.md

@@ -23,7 +23,7 @@ This module allows you to easily integrate Sphinx documentation generation into
 Add the module to your `MODULE.bazel` file:
 
 ```starlark
-bazel_dep(name = "docs-as-code", version = "0.1.0")
+bazel_dep(name = "score_docs_as_code", version = "0.1.0")
 ```
 
 And make sure to also add the S-core bazel registry to your `.bazelrc` file
@@ -40,7 +40,7 @@ ______________________________________________________________________
 #### 1. Import the `docs()` macro in your BUILD file:
 
 ```python
-load("@docs-as-code//docs.bzl", "docs")
+load("@score_docs_as_code//docs.bzl", "docs")
 
 docs(
     conf_dir = "<your sphinc conf dir>",

docs.bzl

@@ -38,22 +38,22 @@
 # For user-facing documentation, refer to `/README.md`.
 
 load("@aspect_rules_py//py:defs.bzl", "py_binary", "py_library")
-load("@docs-as-code//src/extensions/score_source_code_linker:collect_source_files.bzl", "parse_source_files_for_needs_links")
+load("@score_docs_as_code//src/extensions/score_source_code_linker:collect_source_files.bzl", "parse_source_files_for_needs_links")
 load("@pip_process//:requirements.bzl", "all_requirements", "requirement")
 load("@rules_java//java:java_binary.bzl", "java_binary")
 load("@rules_python//sphinxdocs:sphinx.bzl", "sphinx_build_binary", "sphinx_docs")
 load("@rules_python//sphinxdocs:sphinx_docs_library.bzl", "sphinx_docs_library")
 load("@score_python_basics//:defs.bzl", "score_virtualenv")
 
 sphinx_requirements = all_requirements + [
-    "@docs-as-code//src:plantuml_for_python",
-    "@docs-as-code//src/extensions:score_plantuml",
-    "@docs-as-code//src/find_runfiles:find_runfiles",
-    "@docs-as-code//src/extensions/score_draw_uml_funcs:score_draw_uml_funcs",
-    "@docs-as-code//src/extensions/score_header_service:score_header_service",
-    "@docs-as-code//src/extensions/score_layout:score_layout",
-    "@docs-as-code//src/extensions/score_metamodel:score_metamodel",
-    "@docs-as-code//src/extensions/score_source_code_linker:score_source_code_linker",
+    "@score_docs_as_code//src:plantuml_for_python",
+    "@score_docs_as_code//src/extensions:score_plantuml",
+    "@score_docs_as_code//src/find_runfiles:find_runfiles",
+    "@score_docs_as_code//src/extensions/score_draw_uml_funcs:score_draw_uml_funcs",
+    "@score_docs_as_code//src/extensions/score_header_service:score_header_service",
+    "@score_docs_as_code//src/extensions/score_layout:score_layout",
+    "@score_docs_as_code//src/extensions/score_metamodel:score_metamodel",
+    "@score_docs_as_code//src/extensions/score_source_code_linker:score_source_code_linker",
 ]
 
 def docs(source_files_to_scan_for_needs_links = None, source_dir = "docs", conf_dir = "docs", build_dir_for_incremental = "_build", docs_targets = []):
@@ -67,7 +67,7 @@ def docs(source_files_to_scan_for_needs_links = None, source_dir = "docs", conf_
     sphinx_build_binary(
         name = "sphinx_build",
         visibility = ["//visibility:public"],
-        data = ["@docs-as-code//src:docs_assets", "@docs-as-code//src:score_extension_files"],
+        data = ["@score_docs_as_code//src:docs_assets", "@score_docs_as_code//src:score_extension_files"],
         deps = sphinx_requirements,
     )
 
@@ -124,10 +124,10 @@ def _incremental(incremental_name = "incremental", live_name = "live_preview", s
 
     py_binary(
         name = incremental_name,
-        srcs = ["@docs-as-code//src:incremental.py"],
+        srcs = ["@score_docs_as_code//src:incremental.py"],
         deps = dependencies,
         # TODO: Figure out if we need all dependencies as data here or not.
-        data = [":score_source_code_parser", "@docs-as-code//src:plantuml", "@docs-as-code//src:docs_assets"] + dependencies,
+        data = [":score_source_code_parser", "@score_docs_as_code//src:plantuml", "@score_docs_as_code//src:docs_assets"] + dependencies,
         env = {
             "SOURCE_DIRECTORY": source_dir,
             "CONF_DIRECTORY": conf_dir,
@@ -139,9 +139,9 @@ def _incremental(incremental_name = "incremental", live_name = "live_preview", s
 
     py_binary(
         name = live_name,
-        srcs = ["@docs-as-code//src:incremental.py"],
+        srcs = ["@score_docs_as_code//src:incremental.py"],
         deps = dependencies,
-        data = ["@docs-as-code//src:plantuml", "@docs-as-code//src:docs_assets"] + dependencies,
+        data = ["@score_docs_as_code//src:plantuml", "@score_docs_as_code//src:docs_assets"] + dependencies,
         env = {
             "SOURCE_DIRECTORY": source_dir,
             "CONF_DIRECTORY": conf_dir,
@@ -191,8 +191,8 @@ def _docs(name = "docs", format = "html", external_needs_deps = list(), external
         ],
         tools = [
             ":score_source_code_parser",
-            "@docs-as-code//src:plantuml",
-            "@docs-as-code//src:docs_assets",
+            "@score_docs_as_code//src:plantuml",
+            "@score_docs_as_code//src:docs_assets",
         ] + external_needs_deps,
         visibility = ["//visibility:public"],
     )

process-docs/conf.py

@@ -22,15 +22,15 @@
 # -- Project information -----------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
 
-project = "docs-as-code"
+project = "score_docs_as_code"
 author = "Score"
 version = "0.1"
 
 # -- General configuration ---------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
 
 logger = logging.getLogger("process-docs")
-logger.debug("Loading docs-as-code conf.py")
+logger.debug("Loading score_docs_as_code conf.py")
 
 
 extensions = [

src/BUILD

@@ -49,8 +49,8 @@ java_binary(
 # upgrade of `aspect_rules_py` since the py_venv rule now supports a data field
 py_library(
     name = "plantuml_for_python",
-    srcs = ["@docs-as-code//src:dummy.py"],
-    data = ["@docs-as-code//src:plantuml"],
+    srcs = ["@score_docs_as_code//src:dummy.py"],
+    data = ["@score_docs_as_code//src:plantuml"],
     visibility = ["//visibility:public"],
 )
 

src/README.md

@@ -54,7 +54,7 @@ It should be treated as a 'get-started' guide, giving you all needed information
 
 
 
-## docs-as-code Directory Architecture
+## score_docs_as_code Directory Architecture
 
 ```
 process-docs/         # Local documentation to test functionality

src/extensions/BUILD

@@ -24,7 +24,7 @@ load("@score_python_basics//:defs.bzl", "score_py_pytest", "score_virtualenv")
 
 py_library(
     name = "score_plantuml",
-    srcs = ["@docs-as-code//src/extensions:score_plantuml.py"],
+    srcs = ["@score_docs_as_code//src/extensions:score_plantuml.py"],
     imports = ["."],
     visibility = ["//visibility:public"],
 )

src/extensions/score_layout/__init__.py

@@ -39,12 +39,12 @@ def update_config(app: Sphinx, _config: Any):
     # For now this seems the only place this is used / needed.
     # In the future it might be a good idea to make this available in other places, maybe via the 'find_runfiles' lib
     if r := os.getenv("RUNFILES_DIR"):
-        dirs = [str(x) for x in Path(r).glob("*docs-as-code~")]
+        dirs = [str(x) for x in Path(r).glob("*score_docs_as_code~")]
         if dirs:
-            # Happens if 'docs-as-code' is used as Module
-            p = str(r) + "/docs-as-code~/src/assets"
+            # Happens if 'score_docs_as_code' is used as Module
+            p = str(r) + "/score_docs_as_code~/src/assets"
         else:
-            # Only happens in 'docs-as-code' repository
+            # Only happens in 'score_docs_as_code' repository
             p = str(r) + "/_main/src/assets"
         app.config.html_static_path = app.config.html_static_path + [p]
 

src/extensions/score_plantuml.py

@@ -71,14 +71,14 @@ def get_runfiles_dir() -> Path:
 
 def find_correct_path(runfiles: str) -> str:
     """
-    This ensures that the 'plantuml' binary path is found in local 'docs-as-code' and module use.
+    This ensures that the 'plantuml' binary path is found in local 'score_docs_as_code' and module use.
     """
-    dirs = [str(x) for x in Path(runfiles).glob("*docs-as-code~")]
+    dirs = [str(x) for x in Path(runfiles).glob("*score_docs_as_code~")]
     if dirs:
-        # Happens if 'docs-as-code' is used as Module
-        p = runfiles + "/docs-as-code~/src/plantuml"
+        # Happens if 'score_docs_as_code' is used as Module
+        p = runfiles + "/score_docs_as_code~/src/plantuml"
     else:
-        # Only happens in 'docs-as-code' repository
+        # Only happens in 'score_docs_as_code' repository
         p = runfiles + "/../plantuml"
     return p