Merge pull request #45 from pinellolab/dev #270
This file contains 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: "Sphinx: Render docs" | |
on: push | |
jobs: | |
build: | |
runs-on: ubuntu-latest | |
steps: | |
- uses: actions/checkout@v4 | |
- name: Set up Python | |
uses: actions/setup-python@v3 | |
with: | |
python-version: '3.x' | |
- name: Install Sphinx & Dependencies | |
run: | | |
pip install sphinx sphinx_markdown_builder sphinx_rtd_theme sphinx-argparse m2r pandas bio "docutils==0.20" | |
sudo apt-get install python3-distutils | |
- name: Build Documentation | |
working-directory: docs | |
run: sphinx-build . _build | |
- name: copy image files | |
run: cp -r docs/assets docs/_build/ | |
- uses: actions/upload-pages-artifact@v3 | |
with: | |
name: github-pages | |
path: docs/_build/ | |
deploy: | |
needs: build | |
if: github.ref == 'refs/heads/main' | |
permissions: | |
id-token: write | |
pages: write | |
environment: | |
name: github-pages | |
url: ${{ steps.deployment.outputs.page_url }} | |
runs-on: ubuntu-latest | |
steps: | |
- name: Deploy to GitHub Pages | |
id: deployment | |
uses: actions/deploy-pages@v4 |