Documentation tied to version of compas pkg.
See original GitHub issueDocumentation tied to version of compas pkg.
Problem description
I’d guess that the majority of users are installing compas from pypi or conda which means that they are installing the repo at a tagged commit. If they want to view the documentation online however they will see documentation from the most recent commit, which could cause confusion.
So the correct (version specific) documentation will be available in the installed package but not online.
Proposed solution
I think it would be good to consider a system that allows documentation tied to tagged commits.
Two examples with both works with Sphinx would be:
Sphinxcontrib-versioning could probably work with our current Invoke
solution while a solution like ReadTheDocs would mean having the docs built and hosted by another service.
If there’s interest I’d happily help making this change.
Issue Analytics
- State:
- Created 4 years ago
- Comments:13 (13 by maintainers)
I’m currently updating the examples (
docs/examples/
) to make them work with v0.7.2. I’m not sure the examples as they are set up now could be tied to versions… I’ll have a look.Generic Ping.
I see that
compas_fab
have this versioning already. I don’t know the implementation details but maybe we can use the same system? https://github.com/compas-dev/compas_fab/pull/196Maybe @gonzalocasas have some experience?