Compare commits

...

3 Commits

Author SHA1 Message Date
Andrew Morgan
d50c5996b9 changelog 2024-01-26 13:32:13 -07:00
Andrew Morgan
dfb5598c45 temporarily build docs on PRs, but don't deploy 2024-01-26 13:31:23 -07:00
Andrew Morgan
3e63e90e8d Pin Python version in dev-docs CI to 3.11 2024-01-26 13:28:02 -07:00
2 changed files with 15 additions and 13 deletions

View File

@@ -9,6 +9,7 @@ on:
- 'release-v*' - 'release-v*'
# stable docs # stable docs
- master - master
pull_request:
workflow_dispatch: workflow_dispatch:
@@ -79,12 +80,12 @@ jobs:
cp book/welcome_and_overview.html book/index.html cp book/welcome_and_overview.html book/index.html
# Deploy to the target directory. # Deploy to the target directory.
- name: Deploy to gh pages # - name: Deploy to gh pages
uses: peaceiris/actions-gh-pages@373f7f263a76c20808c831209c920827a82a2847 # v3.9.3 # uses: peaceiris/actions-gh-pages@373f7f263a76c20808c831209c920827a82a2847 # v3.9.3
with: # with:
github_token: ${{ secrets.GITHUB_TOKEN }} # github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./book # publish_dir: ./book
destination_dir: ./${{ needs.pre.outputs.branch-version }} # destination_dir: ./${{ needs.pre.outputs.branch-version }}
################################################################################ ################################################################################
pages-devdocs: pages-devdocs:
@@ -98,7 +99,7 @@ jobs:
- name: "Set up Sphinx" - name: "Set up Sphinx"
uses: matrix-org/setup-python-poetry@v1 uses: matrix-org/setup-python-poetry@v1
with: with:
python-version: "3.x" python-version: "3.11"
poetry-version: "1.3.2" poetry-version: "1.3.2"
groups: "dev-docs" groups: "dev-docs"
extras: "" extras: ""
@@ -109,9 +110,9 @@ jobs:
poetry run make html poetry run make html
# Deploy to the target directory. # Deploy to the target directory.
- name: Deploy to gh pages # - name: Deploy to gh pages
uses: peaceiris/actions-gh-pages@373f7f263a76c20808c831209c920827a82a2847 # v3.9.3 # uses: peaceiris/actions-gh-pages@373f7f263a76c20808c831209c920827a82a2847 # v3.9.3
with: # with:
github_token: ${{ secrets.GITHUB_TOKEN }} # github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./dev-docs/_build/html # publish_dir: ./dev-docs/_build/html
destination_dir: ./dev-docs/${{ needs.pre.outputs.branch-version }} # destination_dir: ./dev-docs/${{ needs.pre.outputs.branch-version }}

1
changelog.d/16856.doc Normal file
View File

@@ -0,0 +1 @@
Fix building the developer documentation on the `develop` branch.