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.

Sign up for GitHub

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

Jump to bottom

setup.py: Add sphinx-rtd-theme package #72

Closed
wants to merge 1 commit into from
Closed

setup.py: Add sphinx-rtd-theme package #72

wants to merge 1 commit into from

Conversation

shanthanu9
Copy link

sphinx-multiversion gives the below error when sphinx-rtd-theme package is not present:

Failed load config for refs/tags/v0.2 from /tmp/tmpxu2bycw5/5a6e6147cd15c6552c72dadd35e6b44ab8ae7a3c/docs/source
Failed load config for refs/tags/v0.2.1 from /tmp/tmpxu2bycw5/59d6100ea24a0c2dad87d2202e3f3455c0a8f589/docs/source
Failed load config for refs/tags/v0.3 from /tmp/tmpxu2bycw5/42b7d8000e9227a5e25c91a1039312331c16492c/docs/source

After I installed sphinx-rtd-theme, the above error got resolved. So I believe sphinx-rtd-theme should be present in setup.py file.

This should also resolve #57. I faced a similar issue on GitLab CI, where the sphinx-multiversion build was failing and producing the above error. After I installed sphinx-rtd-theme in GitLab CI, the build ran fine without any errors.

@Holzhaus
Copy link
Collaborator

Can you check if your conf.py contains import sphinx_rtd_theme?

It looks like it fails to load the config because your documentation needs the package to be able to build it, not sphinx-multiversion.

@shanthanu9
Copy link
Author

No my conf.py doesn't import sphinx_rtd_theme. But I just realized what could have been the issue.. I was previously using sphinx-rtd-theme and then shifted to furo theme. So I guess sphinx-multiversion needed sphinx-rtd-theme to build docs for older versions.

I will close this PR since it's no longer relevant. Thanks for the help!

@shanthanu9 shanthanu9 closed this May 26, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Documentation build fails on Travis CI
2 participants
@shanthanu9 @Holzhaus