Add documentation page #1
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| name: Deploy Documentation | |
| on: | |
| push: | |
| branches: [main] | |
| paths: | |
| - "docs/**" | |
| - "scripts/charts/**" | |
| - "scripts/generate_docs.py" | |
| - "README.md" | |
| - ".github/workflows/deploy-docs.yml" | |
| workflow_dispatch: | |
| permissions: | |
| contents: read | |
| pages: write | |
| id-token: write | |
| concurrency: | |
| group: "pages" | |
| cancel-in-progress: true | |
| jobs: | |
| build: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout | |
| uses: actions/checkout@v4 | |
| # ── Python: generate charts ── | |
| - name: Set up Python | |
| uses: actions/setup-python@v5 | |
| with: | |
| python-version: "3.12" | |
| - name: Install Python dependencies | |
| run: | | |
| pip install --upgrade pip | |
| pip install poetry | |
| poetry install --no-interaction | |
| pip install plotly kaleido | |
| - name: Generate indicator charts | |
| run: python scripts/charts/generate_all.py --download | |
| # ── Python: generate doc pages from README ── | |
| - name: Generate doc pages | |
| run: python scripts/generate_docs.py | |
| # ── Copy images to Docusaurus static dir ── | |
| - name: Copy indicator images to docs | |
| run: | | |
| mkdir -p docs/static/img/indicators | |
| cp static/images/indicators/*.png docs/static/img/indicators/ | |
| # ── Node: build Docusaurus ── | |
| - name: Set up Node.js | |
| uses: actions/setup-node@v4 | |
| with: | |
| node-version: 20 | |
| cache: npm | |
| cache-dependency-path: docs/package-lock.json | |
| - name: Install docs dependencies | |
| working-directory: docs | |
| run: npm ci | |
| - name: Build Docusaurus | |
| working-directory: docs | |
| run: npm run build | |
| - name: Upload artifact | |
| uses: actions/upload-pages-artifact@v3 | |
| with: | |
| path: docs/build | |
| 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 |