Thanks to visit codestin.com
Credit goes to github.com

Skip to content

DOC: automatically build docs for stable (on version) and latest (on push) #59

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
martinfleis merged 1 commit into from
Jan 8, 2026
Merged

DOC: automatically build docs for stable (on version) and latest (on push) #59

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 6 additions & 3 deletions .github/workflows/build_docs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ name: Build Docs
on:
push:
branches: [main]
tags:
- "v*"
workflow_dispatch:
inputs:
version:
Expand All @@ -17,7 +19,7 @@ jobs:
timeout-minutes: 90
strategy:
matrix:
os: ['ubuntu-latest']
os: ["ubuntu-latest"]
environment-file: [ci/py313_latest.yaml]
experimental: [false]
defaults:
Expand All @@ -34,10 +36,10 @@ jobs:
uses: mamba-org/setup-micromamba@v2
with:
environment-file: ${{ matrix.environment-file }}
micromamba-version: 'latest'
micromamba-version: "latest"

- name: install package
run: pip install .
run: pip install . --no-deps

- name: make docs
run: cd docs; make html
Expand All @@ -48,3 +50,4 @@ jobs:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: docs/build/html/
keep_files: false
destination_dir: ${{ github.ref_type == 'tag' && 'stable' || 'latest' }}
1 change: 1 addition & 0 deletions ci/py313_latest.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ dependencies:
- pytest-xdist
- pytest-doctestplus
# docs
- pandarm
- ipykernel
- myst-nb
- sphinx
Expand Down
8 changes: 7 additions & 1 deletion docs/source/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -142,6 +142,12 @@
},
},
],
"version_dropdown": True,
"version_info": [
{"version": "stable", "title": "stable", "aliases": []},
{"version": "latest", "title": "latest", "aliases": []},
],
}
nb_execution_mode = "off"
nb_execution_mode = "cache"
nb_execution_timeout = -1
autodoc_typehints = "none"