Missing sphinx_rtd_theme required by default when appending docs/conf.py

[cedk]

Details

• Read the Docs project URL: https://readthedocs.org/projects/trytond-product-price-list-cache/
• Build URL (if applicable): https://readthedocs.org/projects/trytond-product-price-list-cache/builds/21589803/

Expected Result

As auto-created readthedocs.org specific configuration define 'sphinx_rtd_theme' as html_theme, it is expected that it install the required dependencies.
It was doing it until few days.

Actual Result

The build fails because of:

Theme error:
no theme named 'sphinx_rtd_theme' found (missing theme.conf?)

[witolddebski]

I added "sphinx_rtd_theme" in requirements.txt and it solved the issue. Please also mind that you need to add reference to requirements.txt in .readthedocs.yaml as follows (it is commented out by default):

python:
  install:
    - requirements: requirements.txt

[cedk]

Indeed but we should not have to maintain the dependencies of the default theme.conf.

[jayunit100]

seeing this as well...

[jayunit100]

making output directory... done
...
    app = Sphinx(args.sourcedir, args.confdir, args.outputdir,
    self.theme = theme_factory.create(themename)
...
sphinx.errors.ThemeError: no theme named 'sphinx_rtd_theme' found (missing theme.conf?)
...
no theme named 'sphinx_rtd_theme' found (missing theme.conf?)

[jayunit100]

ok, followed the above hint... and it gets further after adding the sphinx_rtd_theme to requirements.txt... but now i see

.. autosummary::
   :toctree: generated
...
ERROR: Unknown directive type "autofunction".
...
ERROR: Unknown directive type "autoexception".
.. autoexception:: lumache.InvalidKindError
...
Sphinx error:
root file /home/docs/checkouts/readthedocs.org/user_builds/storyworld0/checkouts/latest/docs/index.rst not found

[stsewd]

Hi, for new projects we aren't installing the RTD nor other libs by default, see https://blog.readthedocs.com/python-core-requirements-changed/. We recommend that your project installs the proper dependencies explicitly.

[cedk]

But the default conf.py is using sphinx_rtd_theme so it should be installed by default.
The minimal requirement provided on https://blog.readthedocs.com/migrate-configuration-v2/#adding-a-configuration-file does not set sphinx_rtd_theme as requirements.
As long as the appended configuration push sphinx_rtd_theme as dependency, it should be installed by default.

[humitos]

@cedk the default conf.py file is deprecated as well and it will be removed soon. See https://blog.readthedocs.com/doctool-without-configuration-file/

This issue is a temporal inconsistency, but I'll be removed once the date arrives 😊

[humitos]

@cedk the default conf.py file is deprecated as well and it will be removed soon. See https://blog.readthedocs.com/doctool-without-configuration-file/

This issue is a temporal inconsistency, but I'll be removed once the date arrives 😊

[cedk]

I mean the part that is added automatically to the conf.py. In my case I have a conf.py.
What will then happen to my build?

[humitos]

@cedk

I mean the part that is added automatically to the conf.py. In my case I have a conf.py.

Hrm... that's a good point. I will re-open this issue for now.

What will then happen to my build?

If you define the html_theme in your conf.py it should not be overwritten by Read the Docs.

[cedk]

What will then happen to my build?

If you define the html_theme in your conf.py it should not be overwritten by Read the Docs.

Agree but if I do not, what is the html_theme that will be used in the furture? If it is sphinx_rtd_theme, I think it should be installed automatically.

[humitos]

what is the html_theme that will be used in the furture?

I opened a PR that removes this auto-configure the Read the Docs theme already at #10638. We need to coordinate how to deploy it now to avoid breaking existing projects.

[tkoskela]

The tutorial template is failing the first build with this error for me

[jpmckinney]

#10638 introduced a bug, that I reported in that PR.