search

Holzhaus / sphinx-multiversion

Sphinx extension for building self-hosted versioned docs.
https://holzhaus.github.io/sphinx-multiversion/
BSD 2-Clause "Simplified" License
148 stars 65 forks source link

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

Closed shanthanu9 closed 3 years ago

shanthanu9 commented 3 years ago

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 commented 3 years ago

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 commented 3 years ago

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!