Skip to content

Comments

Separate stable and dev documentation deployments with version switcher#984

Draft
Copilot wants to merge 4 commits intodevelopfrom
copilot/update-stable-version-webpage
Draft

Separate stable and dev documentation deployments with version switcher#984
Copilot wants to merge 4 commits intodevelopfrom
copilot/update-stable-version-webpage

Conversation

Copy link
Contributor

Copilot AI commented Feb 20, 2026

  • Fix release in docs/source/conf.py to distinguish dev vs stable using BUILD_DEV_HTML env var
  • Add version switcher configuration to html_theme_options in conf.py
  • Fix linkcode_resolve to use correct branch (develop for dev, master for stable)
  • Update html_baseurl and github_version in conf.py to be branch-aware
  • Create docs/source/_static/switcher.json with stable and dev version entries
  • Update .github/workflows/docs.yml to set BUILD_DEV_HTML=1 on develop branch builds
  • Rename and split deploy jobs: developdocs/dev/, masterdocs/ (stable) for both neurotechx and gh-pages
  • Add changelog entry to docs/source/whats_new.rst
  • Run pre-commit on all changed files (fixed JSON formatting in switcher.json)
Original prompt

This section details on the original issue you should resolve

<issue_title>Development and stable version webpage</issue_title>
<issue_description>At the moment, we have dev as the stable version. This lead to situation where people have mismatched with pip version and what the documentation is showing.</issue_description>

Comments on the Issue (you are @copilot in this section)


💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

Co-authored-by: bruAristimunha <42702466+bruAristimunha@users.noreply.github.com>
Copilot AI changed the title [WIP] Update stable version on development webpage Separate stable and dev documentation deployments with version switcher Feb 20, 2026
Copilot AI requested a review from bruAristimunha February 20, 2026 09:44
@bruAristimunha
Copy link
Collaborator

Ignore the braindecode test and fix the other issues please.

@bruAristimunha
Copy link
Collaborator

@copilot, address the comments above

Co-authored-by: bruAristimunha <42702466+bruAristimunha@users.noreply.github.com>
Copy link
Contributor Author

Copilot AI commented Feb 20, 2026

@copilot, address the comments above

Fixed in 39c1d48 — added the missing changelog entry to docs/source/whats_new.rst, which resolves the "Check What's News Changes" CI failure. The braindecode test failure is unrelated to these changes and pre-exists on the develop branch.

@bruAristimunha
Copy link
Collaborator

Pre commit please @copilot

Co-authored-by: bruAristimunha <42702466+bruAristimunha@users.noreply.github.com>
Copy link
Contributor Author

Copilot AI commented Feb 20, 2026

Pre commit please @copilot

Done in 291ef12 — ran pre-commit on all changed files. The only fix needed was reformatting switcher.json to use 4-space indentation (required by the pretty-format-json hook). All other hooks (black, isort, ruff, codespell, etc.) passed without changes.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Development and stable version webpage

2 participants