Skip to content
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.

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

Provide docs for multiple versions #713

Closed
prjemian opened this issue Sep 27, 2022 · 10 comments · Fixed by #775
Closed

Provide docs for multiple versions #713

prjemian opened this issue Sep 27, 2022 · 10 comments · Fixed by #775

Comments

@prjemian
Copy link
Contributor

PyData provides a dropdown version selector in the header of each page using a JSON catalog of versions available: switcher.json. A search of the source repository provides indications how the feature is supported.

Originally posted by @prjemian in #712 (comment)

@prjemian prjemian added this to the 1.6.5 milestone Sep 27, 2022
@prjemian prjemian added this to To do in 1.6.6 project Sep 27, 2022
@prjemian prjemian modified the milestones: 1.6.6, 1.6.7 Oct 12, 2022
@prjemian prjemian removed this from To do in 1.6.6 project Oct 12, 2022
@prjemian prjemian added this to To do in 1.6.9 project via automation Oct 12, 2022
@prjemian prjemian modified the milestones: 1.6.9, 1.6.10 Nov 3, 2022
@prjemian prjemian added this to To do in 1.6.10 project via automation Nov 3, 2022
@prjemian prjemian removed this from To do in 1.6.9 project Nov 3, 2022
@prjemian
Copy link
Contributor Author

prjemian commented Jan 1, 2023

This discussion is relevant: pydata/pydata-sphinx-theme#1013

@prjemian
Copy link
Contributor Author

prjemian commented Jan 1, 2023

Documentation of switcher.

@prjemian
Copy link
Contributor Author

prjemian commented Jan 1, 2023

Looking for suggestions how to implement the cache of previous documentation versions (with efficiency so that old docs are not rebuilt repeatedly). And yet the cache of older documentation does not grow indefinitely.

@prjemian
Copy link
Contributor Author

prjemian commented Jan 1, 2023

Also, consider adding a loud banner when looking at any unreleased docs, such as bokeh.

@prjemian
Copy link
Contributor Author

prjemian commented Jan 1, 2023

Numpy is a package that manages its documentation sets outside of RTD. It provides old versions on a separate page rather than a dropdown.

Circle CI manages the cache of old documentation versions.

@prjemian
Copy link
Contributor Author

prjemian commented Jan 1, 2023

One idea: upload release artifacts

@prjemian
Copy link
Contributor Author

prjemian commented Jan 1, 2023

@prjemian
Copy link
Contributor Author

prjemian commented Jan 1, 2023

@prjemian
Copy link
Contributor Author

prjemian commented Jan 1, 2023

First part of the numpy switcher file:

[
    {
        "name": "dev",
        "version": "devdocs",
        "url": "https://numpy.org/devdocs/"
    },
    {
        "name": "1.24 (stable)",
        "version": "doc/1.24",
        "url": "https://numpy.org/doc/stable/"
    },
    {
        "name": "1.23",
        "version": "doc/1.23",
        "url": "https://numpy.org/doc/1.23/"
    },
    {
        "name": "1.22",
        "version": "1.22",
        "url": "https://numpy.org/doc/1.22/"
    }
]

@prjemian
Copy link
Contributor Author

prjemian commented Jan 1, 2023

The JSON file needs to be at a stable, persistent, fully-resolved URL

such as ROOT/docs/source/_static/switcher.json

-- https://github.com/pydata/pydata-sphinx-theme/blob/3ee5fcab93b3cf2eb8a18b6b0b5f4b30aaf9bb3b/docs/user_guide/version-dropdown.rst#L75

@prjemian prjemian changed the title Provide docs for any version Provide docs for multiple versions Jan 6, 2023
prjemian added a commit that referenced this issue Jan 7, 2023
prjemian added a commit that referenced this issue Jan 7, 2023
prjemian added a commit that referenced this issue Jan 7, 2023
prjemian added a commit that referenced this issue Jan 7, 2023
prjemian added a commit that referenced this issue Jan 7, 2023
prjemian added a commit that referenced this issue Jan 7, 2023
prjemian added a commit that referenced this issue Jan 7, 2023
1.6.10 project automation moved this from To do to Done Jan 7, 2023
prjemian added a commit that referenced this issue Jan 7, 2023
prjemian added a commit that referenced this issue Jan 7, 2023
prjemian added a commit that referenced this issue Jan 7, 2023
prjemian added a commit that referenced this issue Jan 7, 2023
prjemian added a commit that referenced this issue Jan 7, 2023
prjemian added a commit that referenced this issue Jan 7, 2023
prjemian added a commit that referenced this issue Jan 7, 2023
prjemian added a commit that referenced this issue Jan 7, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
No open projects
Development

Successfully merging a pull request may close this issue.

1 participant