diff --git a/.github/workflows/sphinx_deploy.yml b/.github/workflows/sphinx_deploy.yml new file mode 100644 index 0000000..fdafd87 --- /dev/null +++ b/.github/workflows/sphinx_deploy.yml @@ -0,0 +1,56 @@ +name: Deploy docs site with Sphinx +on: + push: + branches: ["main"] + + # Allows you to run this workflow manually from the Actions tab + workflow_dispatch: + +# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages +permissions: + contents: read + pages: write + id-token: write + +# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued. +# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete. +concurrency: + group: "pages" + cancel-in-progress: false + +# Default to bash +defaults: + run: + shell: bash + +jobs: + build: + runs-on: ubuntu-latest + steps: + - name: Checkout + uses: actions/checkout@v4 + with: + submodules: recursive + - name: Setup Pages + id: pages + uses: actions/configure-pages@v4 + - name: Sphinx build + uses: jsix-os/sphinx-action@master + with: + docs-folder: "docs/" + - name: Upload artifact + uses: actions/upload-pages-artifact@v3 + with: + path: ./docs/_build/html + + # Deployment job + deploy: + environment: + name: github-pages + url: ${{ steps.deployment.outputs.page_url }} + runs-on: ubuntu-latest + needs: build + steps: + - name: Deploy to GitHub Pages + id: deployment + uses: actions/deploy-pages@v4 diff --git a/docs/index.rst b/docs/index.rst index 8c3fceb..9ce70f6 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -70,7 +70,6 @@ The jsix kernel is quite far along now, but the userland systems are still lacki :maxdepth: 1 :caption: Site Contents: - index syscall_interface diff --git a/docs/requirements.txt b/docs/requirements.txt new file mode 100644 index 0000000..71edf05 --- /dev/null +++ b/docs/requirements.txt @@ -0,0 +1,5 @@ +cogapp >= 3 +pyyaml >= 5.4 +lark == 0.12.0 +sphinx +renku-sphinx-theme