From 2e876240ef88e8ed7612a7b7911dbb3a548d5e2f Mon Sep 17 00:00:00 2001 From: x-team <> Date: Wed, 6 Nov 2024 14:33:21 -0600 Subject: [PATCH] Configuration for documentation generation --- .github/workflows/docs.yml | 46 ++++++++++++++++++++++++++++++++++++++ docs/conf.py | 2 ++ 2 files changed, 48 insertions(+) create mode 100644 .github/workflows/docs.yml create mode 100644 docs/conf.py diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml new file mode 100644 index 0000000..6c45dca --- /dev/null +++ b/.github/workflows/docs.yml @@ -0,0 +1,46 @@ +# Simple workflow for deploying static content to GitHub Pages +name: Generate documentation and deploy to Pages + +on: + # Runs on pushes targeting the default branch + 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 + +jobs: + # Single deploy job since we're just deploying + deploy: + environment: + name: github-pages + url: ${{ steps.deployment.outputs.page_url }} + runs-on: ubuntu-latest + steps: + - name: Checkout + uses: actions/checkout@v4 + - name: Generate docs + uses: ammaraskar/sphinx-action@master + with: + docs-folder: "docs/" + - uses: actions/upload-artifact@v3 + with: + name: "stitch-docs" + path: "docs/_build/html/" + - name: Deploy to GitHub Pages + id: deployment + uses: actions/deploy-pages@v4 + with: + artifact_name: "stitch-docs" \ No newline at end of file diff --git a/docs/conf.py b/docs/conf.py new file mode 100644 index 0000000..330a434 --- /dev/null +++ b/docs/conf.py @@ -0,0 +1,2 @@ +project = "Stitch" +author = "X"