ReadTheDocs not compiling docs correctly with furo

[fortwoone]

OK, so I installed furo as instructed by the quickstart, and while my docs compile fine locally, I can't fathom for the life of me why ReadTheDocs does NOT compile it as well and throws an error in my face...

Here's the conf.py file I use :

# Configuration file for the Sphinx documentation builder.
#
# For the full list of built-in configuration values, see the documentation:
# https://www.sphinx-doc.org/en/master/usage/configuration.html

# -- Project information -----------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information

project = 'PyZora'
copyright = '2023, fortwoone'
author = 'fortwoone'
release = '1.0.0'

# -- General configuration ---------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration

extensions = []

templates_path = ['_templates']
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']



# -- Options for HTML output -------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output

# html_theme_path = ["_themes"]
html_theme = 'furo'
html_logo = "pyzora.svg"
html_theme_options = {
    'logo_only': True,
    'display_version': False,
}
html_static_path = ['_static']

[dgw]

Saying RTD throws an error without including that error message won't help anyone troubleshoot. But there's an obvious problem in your conf.py: html_theme = 'haiku' doesn't select Furo.

[fortwoone]

That one’s my fault. I switched to a builtin Sphinx theme because that one compiles fine.

As for the actual error… d’oh, that’s me forgetting to put it here. Let me get the message back

[fortwoone]

Also, to be clear : the docs DO compile fine locally with furo, just not on ReadTheDocs

python -m sphinx -T -E -b html -d _build/doctrees -D language=en . $READTHEDOCS_OUTPUT/html
Running Sphinx v7.2.6
making output directory... done
WARNING: html_static_path entry '_static' does not exist

Traceback (most recent call last):
  File "/home/docs/checkouts/readthedocs.org/user_builds/pyzora/envs/latest/lib/python3.12/site-packages/sphinx/cmd/build.py", line 293, in build_main
    app = Sphinx(args.sourcedir, args.confdir, args.outputdir,
          ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/home/docs/checkouts/readthedocs.org/user_builds/pyzora/envs/latest/lib/python3.12/site-packages/sphinx/application.py", line 272, in __init__
    self._init_builder()
  File "/home/docs/checkouts/readthedocs.org/user_builds/pyzora/envs/latest/lib/python3.12/site-packages/sphinx/application.py", line 342, in _init_builder
    self.builder.init()
  File "/home/docs/checkouts/readthedocs.org/user_builds/pyzora/envs/latest/lib/python3.12/site-packages/sphinx/builders/html/__init__.py", line 219, in init
    self.init_templates()
  File "/home/docs/checkouts/readthedocs.org/user_builds/pyzora/envs/latest/lib/python3.12/site-packages/sphinx/builders/html/__init__.py", line 270, in init_templates
    self.theme = theme_factory.create(themename)
                 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/home/docs/checkouts/readthedocs.org/user_builds/pyzora/envs/latest/lib/python3.12/site-packages/sphinx/theming.py", line 230, in create
    raise ThemeError(__('no theme named %r found (missing theme.conf?)') % name)
sphinx.errors.ThemeError: no theme named 'furo' found (missing theme.conf?)

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

[dgw]

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

Sounds like the theme isn't getting installed before the build. Have you made sure RTD is configured to install the relevant requirements.txt file? https://docs.readthedocs.io/en/stable/config-file/v2.html#requirements-file

(Sorry if there was a double notification; GH had my reply post at the top-level at first, somehow.)

[fortwoone]

Ah, no! Good point. Lemme check that

[fortwoone]

Turns out I didn't. I'll try once more!

[fortwoone]

...and it was that. Thanks for answering!

[dgw]

Glad I could help 🥳