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 #770

Closed
jumaffre opened this issue Jan 31, 2020 · 3 comments · Fixed by #1124
Closed

Versioned documentation #770

jumaffre opened this issue Jan 31, 2020 · 3 comments · Fixed by #1124

Comments

@jumaffre
Copy link
Contributor

We should make sure that our documentation is versioned so that it stays in sync with our releases as well as master.

https://sphinxcontrib-versioning.readthedocs.io/en/latest/index.html seems to be the way to go. However, it does not seem to be actively maintained and I had to apply the patches described here to get it working locally (see for changes required to CCF: https://github.com/microsoft/CCF/compare/master...jumaffre:versioned_docs?expand=1).

The (experimental) command I then ran was: $ sphinx-versioning build -r versioned_docs -w versioned_docs -W sometag sphinx/source ./build/html, which built the default docs (versioned_docs) and the one pointed by sometag.

$ ll ./build/html
_images        design         index.html         operators       sometag
_sources       developers     introduction.html  quickstart      users
_static        genindex.html  members            search.html     versioned_docs
concepts.html  glossary.html  objects.inv        searchindex.js

image

Let's keep an eye on the sphinxcontrib-versioning repo until these issues are fixed and we should hopefully be able to set this up for v0.8.

@achamayou
Copy link
Member

Is sphinxcontrib-versioning what the Python doc uses for multiple releases of the interpreter?

@achamayou
Copy link
Member

@achamayou
Copy link
Member

Let’s give https://github.com/Holzhaus/sphinx-multiversion/ a try when we pick this up.

@achamayou achamayou added 0.9 and removed 0.9 labels Mar 23, 2020
@achamayou achamayou self-assigned this Apr 29, 2020
@achamayou achamayou added the 0.10 label Apr 29, 2020
@achamayou achamayou mentioned this issue Apr 30, 2020
1 task
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants