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

Keep documentation for all released versions #7

Open
mdbenito opened this issue Jan 14, 2023 · 2 comments
Open

Keep documentation for all released versions #7

mdbenito opened this issue Jan 14, 2023 · 2 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@mdbenito
Copy link
Member

mdbenito commented Jan 14, 2023

Update: See #8. Let's NOT use sphinx
Update: There is something called sphinx-multiversion


Manual approach:

  • For each stable release, add a new folder vx.x.x in the branch gh-pages
  • Base URL for all links within a release's docs should be properly set
  • Create a root index.html with a redirect to the latest release
@mdbenito mdbenito added documentation Improvements or additions to documentation enhancement New feature or request labels Jan 14, 2023
@MischaPanch
Copy link
Collaborator

Note that on readthedocs this is done automatically

@mdbenito
Copy link
Member Author

Note that on readthedocs this is done automatically

Mike for mkdocs does this. Sphinx surely has some plugin too. I don't know why I gave some kind of lame steps...

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants