Skip to content

Set up multi-version docs #633

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

Open
niksirbi wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Set up multi-version docs #633

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
afdf4e2
adapt conf.py and docs CI worflow for multi-version docs
niksirbi Nov 12, 2025
50e4287
Update install and get_started links in README
niksirbi Nov 12, 2025
da0f45c
use the stabler v2 version of docs actions
niksirbi Jan 14, 2026
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
11 changes: 8 additions & 3 deletions .github/workflows/docs_build_and_deploy.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ jobs:
name: Build Sphinx Docs
runs-on: ubuntu-latest
steps:
- uses: neuroinformatics-unit/actions/build_sphinx_docs@main
- uses: neuroinformatics-unit/actions/build_sphinx_docs@v2
with:
use-artifactci: lazy

Expand All @@ -33,9 +33,14 @@ jobs:
needs: build_sphinx_docs
permissions:
contents: write
if: github.event_name == 'push' && github.ref_type == 'tag'
# runs on releases, push to main, or manual dispatch on main
if: |
(github.event_name == 'push' && github.ref_type == 'tag') ||
(github.event_name == 'push' && github.ref == 'refs/heads/main') ||
(github.event_name == 'workflow_dispatch' && github.ref == 'refs/heads/main')
runs-on: ubuntu-latest
steps:
- uses: neuroinformatics-unit/actions/deploy_sphinx_docs@v2
- uses: neuroinformatics-unit/actions/deploy_sphinx_docs_multiversion@v2
with:
secret_input: ${{ secrets.GITHUB_TOKEN }}
switcher-url: https://datashuttle.neuroinformatics.dev/latest/_static/switcher.json
4 changes: 2 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@

**datashuttle** is a tool to automate creation, validation and transfer of neuroscience project folders.

Learn how to [Install](https://datashuttle.neuroinformatics.dev/pages/get_started/install.html)
Learn how to [Install](https://datashuttle.neuroinformatics.dev/latest/pages/get_started/install.html)
and
[Get Started](https://datashuttle.neuroinformatics.dev/pages/get_started/index.html)
[Get Started](https://datashuttle.neuroinformatics.dev/latest/pages/get_started/index.html)
on the
[**datashuttle** website](https://datashuttle.neuroinformatics.dev).

Expand Down
9 changes: 8 additions & 1 deletion docs/source/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,12 +23,14 @@
# Retrieve the version number from the package
try:
release = setuptools_scm.get_version(root="../..", relative_to=__file__)
release = release.split(".dev")[0] # remove dev tag and git hash
release = release.split("+")[0] # remove git hash
except LookupError:
# if git is not initialised, still allow local build
# with a dummy version
release = "0.0.0"

doc_version = "dev" if "dev" in release else f"v{release}"

# -- General configuration ---------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration

Expand Down Expand Up @@ -148,6 +150,11 @@
"type": "fontawesome",
},
],
"switcher": {
"json_url": "https://datashuttle.neuroinformatics.dev/latest/_static/switcher.json",
"version_match": doc_version,
},
"navbar_end": ["version-switcher", "theme-switcher", "navbar-icon-links"],
"logo": {
"text": f"datashuttle v{release}",
"image_light": "_static/logo_light.png",
Expand Down
Loading