Skip to content

Deploy multiple versions of the documentation #647

@niksirbi

Description

@niksirbi

At present, we use the build_sphinx_docs and deploy_sphinx_docs actions from our re-usable actions repository, which only deploy a single version of the documentation (corresponding to the latest release) to GitHub Pages.

This means users and contributors cannot view older versions of the docs, except by checking out an old commit and building locally. Having access to documentation for previous releases would be extremely useful, especially when it comes to breaking changes.

Hosting multiple versions online would necessitate making changes to the actions themselves.
I've outlined the plan in more detail here: neuroinformatics-unit/actions#91

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationenhancementNew optional feature

    Type

    No type

    Projects

    Status

    🤔 Triage

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions