From ba6b532dd961a57f5d90b3d06739938730f311bf Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Gr=C3=A9goire=20Paris?= Date: Sat, 2 Sep 2023 19:16:20 +0200 Subject: [PATCH] Mark the sidebar as orphan It has no title, and never will. This removes the need for dynamically adding a dummy title to that document before validating the docs. --- .github/workflows/documentation.yml | 4 ---- docs/en/sidebar.rst | 2 ++ 2 files changed, 2 insertions(+), 4 deletions(-) diff --git a/.github/workflows/documentation.yml b/.github/workflows/documentation.yml index 1465520d387..a3310c533d6 100644 --- a/.github/workflows/documentation.yml +++ b/.github/workflows/documentation.yml @@ -40,9 +40,5 @@ jobs: with: dependency-versions: "highest" - - name: "Add dummy title to the sidebar" - run: | - printf '%s\n%s\n\n%s\n' "Dummy title" "===========" "$(cat docs/en/sidebar.rst)" > docs/en/sidebar.rst - - name: "Run guides-cli" run: "vendor/bin/guides -vvv --no-progress docs/en 2>&1 | ( ! grep 'Unknown directive' )" diff --git a/docs/en/sidebar.rst b/docs/en/sidebar.rst index 0430bcc7504..c87651c2fbe 100644 --- a/docs/en/sidebar.rst +++ b/docs/en/sidebar.rst @@ -1,3 +1,5 @@ +:orphan: + .. toc:: .. tocheader:: Tutorials