docs: document package with pdoc (#108) #74
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
| on: | |
| workflow_dispatch: | |
| push: | |
| branches: | |
| - "main" | |
| name: "gh-pages" | |
| jobs: | |
| build: | |
| runs-on: "ubuntu-latest" | |
| steps: | |
| - uses: "actions/checkout@v4" | |
| - uses: "actions/setup-python@v5" | |
| with: | |
| python-version: "3.x" | |
| - uses: "actions/setup-node@v4" | |
| with: | |
| node-version: "latest" | |
| - run: "pip install catppuccin[pygments,gh-pages]" | |
| - run: "mkdir -p gh-pages/docs/assets/ && cp assets/pepperjack.webp gh-pages/docs/assets/" | |
| - run: "uv run pdoc catppuccin --no-include-undocumented --favicon https://catppuccin.com/favicon.png --logo https://python.catppuccin.com/docs/assets/pepperjack.webp --logo-link / --template-directory pdoc --output-directory gh-pages/docs" | |
| - run: "scripts/build-gh-pages" | |
| - run: "npx lightningcss-cli --minify gh-pages/pygments/*.css --output-dir gh-pages/pygments/" | |
| - uses: "peaceiris/actions-gh-pages@v4" | |
| with: | |
| enable_jekyll: false | |
| github_token: "${{ secrets.GITHUB_TOKEN }}" | |
| publish_branch: "gh-pages" | |
| publish_dir: "./gh-pages" | |
| user_email: "github-actions[bot]@users.noreply.github.com" | |
| user_name: "github-actions[bot]" | |
| cname: "python.catppuccin.com" |