diff --git a/BUILD b/BUILD index feedbbda2..34d7a5e70 100644 --- a/BUILD +++ b/BUILD @@ -27,16 +27,8 @@ docs( ], bundles = [ { - "bundle": "//src/extensions/score_mounts/docs:concept", - "mount_at": "concepts/mounts", - }, - { - "bundle": "//src/extensions/score_mounts/docs:howto", - "mount_at": "how-to/mounts", - }, - { - "bundle": "//src/extensions/score_mounts/docs:internals", - "mount_at": "internals/extensions/mounts", + "bundle": "//src/extensions/docs:extensions", + "mount_at": "internals/extensions", }, { "bundle": "//src/extensions/score_metamodel/docs:metamodel", @@ -44,7 +36,7 @@ docs( "attach_to": "reference/index", }, ], - scan_code = [ + code_targets = [ "//scripts_bazel:sources", "//src:all_sources", ], diff --git a/docs/concepts/index.rst b/docs/concepts/index.rst index b7af70ee4..62f1db4ed 100644 --- a/docs/concepts/index.rst +++ b/docs/concepts/index.rst @@ -24,3 +24,4 @@ Here you find explanations how and why docs-as-code works the way it does. bidirectional_traceability cross_module_compatibility docs_deps + mounts/index diff --git a/src/extensions/score_mounts/docs/concept/index.rst b/docs/concepts/mounts/index.rst similarity index 100% rename from src/extensions/score_mounts/docs/concept/index.rst rename to docs/concepts/mounts/index.rst diff --git a/docs/how-to/index.rst b/docs/how-to/index.rst index ec0db9d14..a820fe89d 100644 --- a/docs/how-to/index.rst +++ b/docs/how-to/index.rst @@ -27,6 +27,7 @@ Here you find practical guides on how to use docs-as-code. write_docs other_modules cross_module_compatibility + mounts/index dashboards_and_quality_gates source_to_doc_links test_to_doc_links diff --git a/src/extensions/score_mounts/docs/howto/index.rst b/docs/how-to/mounts/index.rst similarity index 100% rename from src/extensions/score_mounts/docs/howto/index.rst rename to docs/how-to/mounts/index.rst diff --git a/docs/internals/extensions/data_flow.png b/docs/internals/extensions/data_flow.png deleted file mode 100644 index 92441595f..000000000 Binary files a/docs/internals/extensions/data_flow.png and /dev/null differ diff --git a/docs/internals/index.rst b/docs/internals/index.rst index f0e913836..a5dce3e47 100644 --- a/docs/internals/index.rst +++ b/docs/internals/index.rst @@ -21,7 +21,6 @@ This section is not relevant for users of docs-as-code but for developers extend .. toctree:: :maxdepth: 1 - extensions/index benchmark_results decisions/index requirements/index diff --git a/src/extensions/.gitkeep b/src/extensions/.gitkeep deleted file mode 100644 index e69de29bb..000000000 diff --git a/src/extensions/decision_record.md b/src/extensions/decision_record.md deleted file mode 100644 index d7dfc57c0..000000000 --- a/src/extensions/decision_record.md +++ /dev/null @@ -1,20 +0,0 @@ - - -# Decision Record: Why extensions? - -Instead of setting global variables in conf.py which may be incorrect, -misspelled, have the wrong type etc., we can use extensions to setup sphinx, -sphinx-needs and other extensions. -This way we interact through a typesafe API and can be sure that the -configuration is correct. diff --git a/src/extensions/score_mounts/docs/BUILD b/src/extensions/docs/BUILD similarity index 56% rename from src/extensions/score_mounts/docs/BUILD rename to src/extensions/docs/BUILD index 6e17c274b..a2ea53b9d 100644 --- a/src/extensions/score_mounts/docs/BUILD +++ b/src/extensions/docs/BUILD @@ -13,24 +13,8 @@ load("//:docs.bzl", "docs_bundle") -# The mount feature's own documentation, mounted back into the site via the -# mount feature itself (dogfooding). One subdirectory per bundle: mounts are -# directory-scoped, so co-locating both files in one dir would graft both at -# each mount point. docs_bundle( - name = "concept", - source_dir = "concept", - visibility = ["//visibility:public"], -) - -docs_bundle( - name = "howto", - source_dir = "howto", - visibility = ["//visibility:public"], -) - -docs_bundle( - name = "internals", - source_dir = "internals", + name = "extensions", + source_dir = "", visibility = ["//visibility:public"], ) diff --git a/docs/internals/extensions/extension_guide.md b/src/extensions/docs/extension_guide.md similarity index 100% rename from docs/internals/extensions/extension_guide.md rename to src/extensions/docs/extension_guide.md diff --git a/docs/internals/extensions/index.rst b/src/extensions/docs/index.rst similarity index 91% rename from docs/internals/extensions/index.rst rename to src/extensions/docs/index.rst index cfe2f7c44..0ae5047f4 100644 --- a/docs/internals/extensions/index.rst +++ b/src/extensions/docs/index.rst @@ -63,6 +63,12 @@ Extensions `ubCode `__ VS Code extension. Getting IDE support for Sphinx-Needs in a Bazel context made easy. + .. grid-item-card:: + + Mounts + ^^^ + Architecture and design of the ``score_mounts`` bridge extension. + :ref:`Mounts Extension Internals` .. toctree:: @@ -74,3 +80,4 @@ Extensions Source Code Linker Extension Guide Sync TOML + mounts_internals diff --git a/docs/internals/extensions/metamodel.md b/src/extensions/docs/metamodel.md similarity index 100% rename from docs/internals/extensions/metamodel.md rename to src/extensions/docs/metamodel.md diff --git a/src/extensions/score_mounts/docs/internals/index.rst b/src/extensions/docs/mounts_internals.rst similarity index 100% rename from src/extensions/score_mounts/docs/internals/index.rst rename to src/extensions/docs/mounts_internals.rst diff --git a/docs/internals/extensions/rst_filebased_testing.md b/src/extensions/docs/rst_filebased_testing.md similarity index 100% rename from docs/internals/extensions/rst_filebased_testing.md rename to src/extensions/docs/rst_filebased_testing.md diff --git a/docs/internals/extensions/source_code_linker.md b/src/extensions/docs/source_code_linker.md similarity index 100% rename from docs/internals/extensions/source_code_linker.md rename to src/extensions/docs/source_code_linker.md diff --git a/docs/internals/extensions/sync_toml.rst b/src/extensions/docs/sync_toml.rst similarity index 100% rename from docs/internals/extensions/sync_toml.rst rename to src/extensions/docs/sync_toml.rst