You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
A user reported a bug with our Sphinx configuration file handling and I'm actually surprised we haven't noticed it before.
Though we provide projects with a way to specify the configuration file path, we don't actually explicitly pass this path into Sphinx. If a project uses a configuration file that is not named conf.py, Sphinx will error out.
The code here just seems to set the working path to the configuration directory and assumes that the file will always be named conf.py.
This maybe isn't a strong use case to fix with application code, but I'd agree it is rather confusing. We could change the call to Sphinx, or throw a warning, or maybe just document the issue somewhere, no strong preference.
I've never had a need to use this pattern, but I thought that sphinx-build -c docs/conf-foo.py was enough. It actually is not, as this is strictly just the path to the config file. Guessing there isn't a great way around this, at least not once that's obvious, so might just be worth documenting.
A user reported a bug with our Sphinx configuration file handling and I'm actually surprised we haven't noticed it before.
Though we provide projects with a way to specify the configuration file path, we don't actually explicitly pass this path into Sphinx. If a project uses a configuration file that is not named
conf.py
, Sphinx will error out.The code here just seems to set the working path to the configuration directory and assumes that the file will always be named
conf.py
.This maybe isn't a strong use case to fix with application code, but I'd agree it is rather confusing. We could change the call to Sphinx, or throw a warning, or maybe just document the issue somewhere, no strong preference.
Test build for illustration: https://readthedocs.org/projects/test-builds/builds/18548005/
The text was updated successfully, but these errors were encountered: