From ae07d28bfb6be1a2599d194b2292a72a4b7d4c7e Mon Sep 17 00:00:00 2001 From: Oliver Smith Date: Tue, 16 Jun 2026 13:15:02 +0200 Subject: [PATCH] docs: structure: move CI related pages Signed-off-by: Oliver Smith Part-of: --- docs/ci.md | 11 +++++++++++ docs/{ => ci}/ci-tags.md | 0 docs/{ => ci}/hardware-ci.md | 0 docs/conf.py | 6 ++++++ docs/index.md | 3 +-- docs/kconfigcheck.md | 2 +- 6 files changed, 19 insertions(+), 3 deletions(-) create mode 100644 docs/ci.md rename docs/{ => ci}/ci-tags.md (100%) rename docs/{ => ci}/hardware-ci.md (100%) diff --git a/docs/ci.md b/docs/ci.md new file mode 100644 index 000000000..e332aac0f --- /dev/null +++ b/docs/ci.md @@ -0,0 +1,11 @@ +# Continuous Integration + +These pages are related to continuous integration (CI) in pmaports. + +```{eval-rst} +.. toctree:: + :hidden: + + ci/ci-tags + ci/hardware-ci +``` diff --git a/docs/ci-tags.md b/docs/ci/ci-tags.md similarity index 100% rename from docs/ci-tags.md rename to docs/ci/ci-tags.md diff --git a/docs/hardware-ci.md b/docs/ci/hardware-ci.md similarity index 100% rename from docs/hardware-ci.md rename to docs/ci/hardware-ci.md diff --git a/docs/conf.py b/docs/conf.py index 191ef324c..4227a8634 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -13,6 +13,7 @@ extensions = [ "sphinx.ext.autodoc", "sphinx.ext.autosummary", "sphinx.ext.doctest", + "sphinx_reredirects", "sphinxcontrib.autoprogram", "sphinxcontrib.jquery", ] @@ -26,6 +27,11 @@ html_theme_options = { # Set the explicit title of the HTML output html_title = "postmarketOS Packaging" +# Redirects for moved pages +redirects = { + "ci-tags": "ci/ci-tags.html", + "hardware-ci": "ci/hardware-ci.html", +} def run_dint_doc(app): docs_dir = Path(__file__).parent diff --git a/docs/index.md b/docs/index.md index e53349f9e..5c836db0b 100644 --- a/docs/index.md +++ b/docs/index.md @@ -17,11 +17,10 @@ in pmaports and the processes around device categorization. approval-rules device-categorization deviceinfo-reference - ci-tags + ci firmware generic-device-packages generic-kernels - hardware-ci kconfig-fragments kconfigcheck kernel-cmdline diff --git a/docs/kconfigcheck.md b/docs/kconfigcheck.md index 11fc33550..0a8e438f7 100644 --- a/docs/kconfigcheck.md +++ b/docs/kconfigcheck.md @@ -79,7 +79,7 @@ package maintainers, who must make sure their kernel complies with the changed requirements in the next update to their kernel packages. When making unrelated changes to a kernel package that does not meet the current requirements, one can use the `[ci:skip-kconfigcheck]` CI tag to bypass the checks if -[the situation allows for it](./ci-tags). +[the situation allows for it](ci/ci-tags). Merge requests that change the `kconfigcheck.toml` require approval from members of the kconfigcheck team in GitLab. The team can be pinged on merge