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

Implement multiversion building for the docs #252

Closed
wants to merge 4 commits into from

Conversation

mschmidt87
Copy link
Member

Use sphinx-multiversion instead of sphinx-build
Configure multiversion builds in docs conf file
Use RTD theme because it supports multiversion, remove msmb_theme
Add sphinx-multiversion to requirements

Closes #251 .

You can test this PR locally by running

cd docs
make html

and observing the outcome. There should be a pulldown menu on the bottom left that enables you to switch between master and the 0.2.0 release.

Use sphinx-multiversion instead of sphinx-build
Configure multiversion builds in docs conf file
Use RTD theme because it supports multiversion, remove msmb_theme
Add sphinx-multiversion to requirements
@mschmidt87 mschmidt87 added the doc Improvements or additions to documentation label Nov 12, 2020
@coveralls
Copy link
Collaborator

coveralls commented Nov 12, 2020

Coverage Status

Coverage remained the same at 94.449% when pulling cc81e3a on sphinx_doc/multi_version into f6143c5 on master.

@mschmidt87
Copy link
Member Author

mschmidt87 commented Nov 13, 2020

The build is currently failing, I filed a ticket to ask for help here: Holzhaus/sphinx-multiversion#57

@mschmidt87
Copy link
Member Author

I'm closing this PR because I can't figure out a way to fix this. I am thinking to abandon Travis and switch to Github Actions. Will create a ticket for that.

@mschmidt87 mschmidt87 closed this Jan 5, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Multi-version documentation
2 participants