Skip to content

Commit

Permalink
fix doc-build
Browse files Browse the repository at this point in the history
  • Loading branch information
orgua committed Feb 22, 2024
1 parent 6caff27 commit 75497b6
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 4 deletions.
9 changes: 7 additions & 2 deletions .github/workflows/sphinx_to_pages.yml
Original file line number Diff line number Diff line change
Expand Up @@ -24,10 +24,15 @@ jobs:
pages: write
id-token: write
steps:
- name: Init Submodules (for grabbing readmes) 🔧
run: git submodule update --init --recursive

- name: Checkout 🛎️
uses: actions/checkout@v4
with:
submodules: true # for grabbing readme-files

- name: Build and Push Pages 🧱
uses: sphinx-notes/pages@v3
with:
checkout: false
pyproject_extras: ""
# currently needed because action begins to analyze root pyproject.toml
4 changes: 2 additions & 2 deletions docs/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,8 @@ This is the main entry point into the shepherd ecosystem. Based on your experien
4. To record/emulate data on a group of shepherd nodes, use the [](#herd-cli) command line utility.
5. To access the testbed-instance go to [](external/testbed).
6. If you'd like to contribute or have issues, try the [](dev/contributing)-guide or jump to the [](user/help_me_help_you)-section.
7. The in-depth DevLog-Documentation is in: <https://orgua.github.io/shepherd_v2_planning/>
7. The in-depth DevLog-Documentation is located in: <https://orgua.github.io/shepherd_v2_planning/>

:::{note}
The search-function is often able to find the needle in the haystack
The included search-function is often able to find the needle in the haystack (especially in the overwhelming dev-log)
:::

0 comments on commit 75497b6

Please sign in to comment.