Merge pull request #602 from bartlettroscoe/doc-update-2024-01-31 #158
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: Deploy docs | |
on: | |
push: | |
branches: [ master ] | |
workflow_dispatch: | |
jobs: | |
build-and-deploy-docs: | |
runs-on: ubuntu-latest | |
env: | |
working-directory: ./tribits/doc/sphinx | |
tribits-base-dir: /home/runner/work/TriBITS/TriBITS | |
steps: | |
- uses: actions/checkout@v2 | |
- name: Set up Python 3.9 | |
uses: actions/setup-python@v2 | |
with: | |
python-version: '3.9' | |
architecture: 'x64' | |
- name: Display Python version | |
run: | | |
python -c "import sys; print(sys.version)" | |
python3 -c "import sys; print(sys.version)" | |
- name: Install Python dependencies | |
run: | | |
pip3 install sphinx sphinx-rtd-theme | |
- name: Build documentation | |
working-directory: ${{env.working-directory}} | |
run: | | |
git fetch --prune --unshallow --tags | |
python3 sphinx_rst_generator.py --copy-base-dir=${{env.tribits-base-dir}} | |
- name: Generate nojekyll file | |
working-directory: ${{env.working-directory}}/combined_docs | |
run: touch .nojekyll | |
- name: Deploy docs | |
uses: JamesIves/[email protected] | |
with: | |
branch: deploy-doc-site | |
folder: ${{env.working-directory}}/combined_docs | |
clean: true |