search

maserlib / ExPRES

Exoplanetary and Planetary Radio Emission Simulator
MIT License
4 stars 4 forks source link

readthedocs build failing due to breaking change in sphinxcontrib-bibtex #40

Closed thomas-nilsson-irfu closed 3 years ago

thomas-nilsson-irfu commented 3 years ago

Latest readthedocs build failed https://readthedocs.org/projects/expres/builds/12829644/ log of which (https://readthedocs.org/api/v2/build/12829644.txt) contains:

Collecting sphinxcontrib-bibtex
  Downloading sphinxcontrib_bibtex-2.1.4-py3-none-any.whl (17 kB)
...
...
Traceback (most recent call last):
  File "/home/docs/checkouts/readthedocs.org/user_builds/expres/envs/latest/lib/python3.6/site-packages/sphinx/cmd/build.py", line 279, in build_main
    args.tags, args.verbosity, args.jobs, args.keep_going)
  File "/home/docs/checkouts/readthedocs.org/user_builds/expres/envs/latest/lib/python3.6/site-packages/sphinx/application.py", line 276, in __init__
    self._init_env(freshenv)
  File "/home/docs/checkouts/readthedocs.org/user_builds/expres/envs/latest/lib/python3.6/site-packages/sphinx/application.py", line 312, in _init_env
    self.env.setup(self)
  File "/home/docs/checkouts/readthedocs.org/user_builds/expres/envs/latest/lib/python3.6/site-packages/sphinx/environment/__init__.py", line 216, in setup
    for domain in app.registry.create_domains(self):
  File "/home/docs/checkouts/readthedocs.org/user_builds/expres/envs/latest/lib/python3.6/site-packages/sphinx/registry.py", line 166, in create_domains
    domain = DomainClass(env)
  File "/home/docs/checkouts/readthedocs.org/user_builds/expres/envs/latest/lib/python3.6/site-packages/sphinxcontrib/bibtex/domain.py", line 263, in __init__
    "You must configure the bibtex_bibfiles setting")
sphinx.errors.ExtensionError: You must configure the bibtex_bibfiles setting

Extension error:
You must configure the bibtex_bibfiles setting

Note incompatible changes was introduced in v2.0.0 (back in December of last year): https://sphinxcontrib-bibtex.readthedocs.io/en/2.0.0/changes.html

To fix the issue either update documentation code or manually fixate spinxcontrib-bibtex to an older version (i.e. add something like sphinxcontrib-bibtex<2.0.0 to your docs/requirement.txt).

BaptisteCecconi commented 3 years ago

Thanks @thomas-nilsson-irfu ! I've updated the requirement.txt file and now the doc compiles again !