diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml new file mode 100644 index 0000000..190719f --- /dev/null +++ b/.github/workflows/docs.yml @@ -0,0 +1,50 @@ +name: Deploy documentation + +on: + push: + branches: + - main + paths: + - 'documentation/**' + workflow_dispatch: + +permissions: + contents: read + pages: write + id-token: write + +concurrency: + group: "pages" + cancel-in-progress: false + +jobs: + build: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + + - uses: actions/setup-python@v5 + with: + python-version: '3.x' + + - name: Install dependencies + run: pip install -r documentation/requirements.txt + + - name: Build docs + run: cd documentation && mkdocs build + + - name: Upload artifact + uses: actions/upload-pages-artifact@v3 + with: + path: documentation/site + + deploy: + needs: build + runs-on: ubuntu-latest + environment: + name: github-pages + url: ${{ steps.deployment.outputs.page_url }} + steps: + - name: Deploy to GitHub Pages + id: deployment + uses: actions/deploy-pages@v4 \ No newline at end of file diff --git a/README.md b/README.md index f74fdf2..2f26e55 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,7 @@ TauPlot draws XY plots inside any Godot UI. It supports bar and scatter overlays This repository has just been made public (since 2026-04-14). Finalization steps are currently in progress: -- [ ] Deploy documentation +- [x] Deploy documentation - [ ] Register addon on the Godot Asset Library These steps should be completed within the next few days. diff --git a/documentation/mkdocs.yml b/documentation/mkdocs.yml index c73b929..4d777b9 100644 --- a/documentation/mkdocs.yml +++ b/documentation/mkdocs.yml @@ -1,5 +1,6 @@ site_name: TauPlot documentation site_description: Plotting library for Godot +site_url: https://ze2j.github.io/tau-plot/ nav: - Home: index.md