Docs/move to sphinx-multiversion #104
Conversation
There was a problem hiding this comment.
@orviz if my comments are not an issue in current implementation, I approve the current PR.
docs/_templates/index.html
Outdated
| <title>Redirecting to master branch</title> | ||
| <meta charset="utf-8"> | ||
| <meta http-equiv="refresh" content="0; url=./2.0.0/index.html"> | ||
| <link rel="canonical" href="https://localhost:8081/2.0.0/index.html"> |
There was a problem hiding this comment.
@orviz Shoudn't the url here be with the real domain name for the documentation instead of localhost?
There was a problem hiding this comment.
indeed we don't need this file anymore since we are not longer using html_additional_pages in conf.py
| @@ -344,3 +345,6 @@ | |||
|
|
|||
| # -- Options for sphinx-versioning ------------------------------------------- | |||
| scv_whitelist_branches = ('(stable|release){1}/.+',) | |||
| # -- Options for sphinx-multiversion------------------------------------------ | |||
| smv_branch_whitelist = r'(stable|release){1}/.+' | |||
There was a problem hiding this comment.
@orviz is expected that master branch be excluded from the documentation releases? And what about tags x.y.z?
There was a problem hiding this comment.
when testing the sphinx-multiversion the documentation for the tag 2.0.0 was automatically built, that's why I didn't include a specific definition for the tags. But, as you propose, it does no harm to provide a whitelist for tags too. I've tested it and works as expected.
Docs/move to sphinx-multiversion
Main reason to move away from
sphinx-versioningis that the workaround for the import error issue found in sphinx >1.7 does not work for us.