Skip to content

Commit

Permalink
Mark the sidebar as orphan
Browse files Browse the repository at this point in the history
It has no title, and never will. This removes the need for dynamically
adding a dummy title to that document before validating the docs.
  • Loading branch information
greg0ire committed Sep 2, 2023
1 parent 474f854 commit ba6b532
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 4 deletions.
4 changes: 0 additions & 4 deletions .github/workflows/documentation.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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' )"
2 changes: 2 additions & 0 deletions docs/en/sidebar.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
:orphan:

.. toc::

.. tocheader:: Tutorials
Expand Down

0 comments on commit ba6b532

Please sign in to comment.