You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Is your feature request related to a problem? Please describe.
Currently, we are hosting one version of the docs, specifically a version that is synced with master. However, users might be using older versions of the package. Even if using the most recently released version, this can differ from master (e.g. see #500).
Describe the solution you'd like
Sphinx does, in principle, support a collapsible nav item for multiple versions, see e.g. in this example (bottom left). Ideally, this would store the documentation of each tagged version and master, defaulting to the highest-versioned release.
References or alternative approaches
Relevant links:
Have you considered using readthedocs?
I've done this before, so I don't remember exactly,
but all you need to do is write a .readthedocs.yaml file like this
I think it is indeed quite easy with RTD, but considering that we have to pipeline in place to host via GH pages, I'd like to handle it here, if possible...
Is your feature request related to a problem? Please describe.
Currently, we are hosting one version of the docs, specifically a version that is synced with
master
. However, users might be using older versions of the package. Even if using the most recently released version, this can differ frommaster
(e.g. see #500).Describe the solution you'd like
Sphinx does, in principle, support a collapsible nav item for multiple versions, see e.g. in this example (bottom left). Ideally, this would store the documentation of each
tag
ged version andmaster
, defaulting to the highest-versioned release.References or alternative approaches
Relevant links:
Examples:
Additional context
Does not need to be retroactive -- i.e. once we have it deployed we can simply add versions going forward.
Are you able and willing to implement this feature yourself and open a pull request?
Unfortunately, I don't think I am capable of adding this myself.
The text was updated successfully, but these errors were encountered: