diff options
| author |  Johannes Christ <[email protected]> | 2024-07-24 20:09:42 +0200 |
|---|---|---|
| committer | Johannes Christ <[email protected]> | 2024-07-25 20:06:54 +0200 |
| commit | a4d7e92d544aeb43dbe1fcd8648d97e0dbf7b9d3 (patch) | |
| tree | 183318852234388654c99514e45f095af8c21676 /.github | |
| parent | Add link to DevOps Kanban board in meeting template (#420) (diff) | |
Improve documentation
This commit ports our documentation to Sphinx.
The reason for this is straightforward. We need to improve both the
quality and the accessibility of our documentation. Hugo is not capable
of doing this, as its primary output format is HTML. Sphinx builds
plenty of high-quality output formats out of the box, and incentivizes
writing good documentation.
Diffstat (limited to '.github')
| -rw-r--r-- | .github/workflows/docs.yaml | 21 | ||||
| -rw-r--r-- | .github/workflows/lint-docs.yaml | 10 |
2 files changed, 6 insertions, 25 deletions
diff --git a/.github/workflows/docs.yaml b/.github/workflows/docs.yaml index 8569ea1..d5d7cd6 100644 --- a/.github/workflows/docs.yaml +++ b/.github/workflows/docs.yaml @@ -32,11 +32,6 @@ jobs: build: runs-on: ubuntu-latest steps: - - name: Setup Hugo - uses: peaceiris/actions-hugo@v3 - with: - hugo-version: '0.124.0' - extended: true - name: Checkout uses: actions/checkout@v4 with: @@ -45,21 +40,13 @@ jobs: - name: Setup Pages id: pages uses: actions/configure-pages@v5 - - name: Build with Hugo - env: - # For maximum backward compatibility with Hugo modules - HUGO_ENVIRONMENT: production - HUGO_ENV: production - TZ: UTC - run: | - cd docs && hugo \ - --gc \ - --minify \ - --baseURL "${{ steps.pages.outputs.base_url }}/" + - uses: ammaraskar/sphinx-action@master + with: + docs-folder: "docs/" - name: Upload artifact uses: actions/upload-pages-artifact@v3 with: - path: ./docs/public + path: ./docs/_build/html # Deployment job deploy: diff --git a/.github/workflows/lint-docs.yaml b/.github/workflows/lint-docs.yaml index c616e9a..5b8e978 100644 --- a/.github/workflows/lint-docs.yaml +++ b/.github/workflows/lint-docs.yaml @@ -10,12 +10,6 @@ jobs: with: submodules: recursive fetch-depth: 0 - - name: Setup Hugo - uses: peaceiris/actions-hugo@v3 + - uses: ammaraskar/sphinx-action@master with: - hugo-version: '0.124.0' - extended: true - - name: Run hugo - run: | - cd docs - hugo --panicOnWarning --renderToMemory + docs-folder: "docs/" |