Skip to content

docs: update CONTRIBUTING.md (#96) #47

docs: update CONTRIBUTING.md (#96)

docs: update CONTRIBUTING.md (#96) #47

Workflow file for this run

name: Docs
on:
push:
branches: [main]
jobs:
docs:
runs-on: ubuntu-latest
# 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
steps:
- uses: actions/checkout@v3
- name: Set up Python 3.10
uses: actions/setup-python@v4
with:
python-version: "3.10"
cache: "pip"
cache-dependency-path: |
.github/requirements-docs.txt
- name: Install dependencies
run: pip install -r .github/requirements-docs.txt
- name: Move conf.py to root
# Move sphinx configuration to root since we normally don't want it there
run: mv docs/conf.py conf.py; mv docs/docs_root.md index.md
- name: Build docs
run: |
python -X utf8 -m talondoc autogen -o docs --generate-index
python -X utf8 -m talondoc build ./ docs/_build
- name: Setup Pages
uses: actions/configure-pages@v3
- name: Upload Pages artifact
uses: actions/upload-pages-artifact@v1
with:
path: docs/_build
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v2