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

Versioned documentation #192

Open
uniqueg opened this issue Sep 27, 2022 · 0 comments
Open

Versioned documentation #192

uniqueg opened this issue Sep 27, 2022 · 0 comments

Comments

@uniqueg
Copy link
Contributor

uniqueg commented Sep 27, 2022

It would be nice to have a reference documentation for each API release rather than only having a single documentation version that points to the latest release (or, as it is currently the case, not matching any release at all; see #191).

I am not familiar with the build system for the docs, and whether hosting multiple documentation versions is possible with that system, but for what it's worth, here is how Read the Docs supports multiple documentation versions: https://docs.readthedocs.io/en/stable/versions.html.

If versioning documentation is not feasible, it should be clarified (and ensured) that the reference documentation always points to the latest release, and the actual commit/tag should be explicitly linked to in the documentation.

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

No branches or pull requests

3 participants