From 9acca2252f008b3b6013182b0e2c29b66532c626 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Gr=C3=A9goire=20Paris?= Date: Mon, 11 Mar 2024 20:31:22 +0100 Subject: [PATCH] Remove guides-specific markup doctrine/rst-parser does not appear to support orphan metadata yet, and renders it verbatim on the website. Let's move this to the CI job. --- .github/workflows/documentation.yml | 5 +++++ docs/en/reference/installation.rst | 2 -- docs/en/sidebar.rst | 2 -- 3 files changed, 5 insertions(+), 4 deletions(-) diff --git a/.github/workflows/documentation.yml b/.github/workflows/documentation.yml index bd9ebea8d28..ef8053a211c 100644 --- a/.github/workflows/documentation.yml +++ b/.github/workflows/documentation.yml @@ -40,5 +40,10 @@ jobs: with: dependency-versions: "highest" + - name: "Add orphan metadata where needed" + run: | + printf '%s\n\n%s\n' ":orphan:" "$(cat docs/en/sidebar.rst)" > docs/en/sidebar.rst + printf '%s\n\n%s\n' ":orphan:" "$(cat docs/en/reference/installation.rst)" > docs/en/reference/installation.rst + - name: "Run guides-cli" run: "vendor/bin/guides -vvv --no-progress docs/en 2>&1 | grep -v 'No template found for rendering directive' | ( ! grep WARNING )" diff --git a/docs/en/reference/installation.rst b/docs/en/reference/installation.rst index 2c0d5823009..dab1364f777 100644 --- a/docs/en/reference/installation.rst +++ b/docs/en/reference/installation.rst @@ -1,5 +1,3 @@ -:orphan: - Installation ============ diff --git a/docs/en/sidebar.rst b/docs/en/sidebar.rst index f67304e8457..df3032d65f2 100644 --- a/docs/en/sidebar.rst +++ b/docs/en/sidebar.rst @@ -1,5 +1,3 @@ -:orphan: - .. toc:: .. tocheader:: Tutorials