readthedocs / sphinx_rtd_theme

Sphinx theme from Read the Docs
https://sphinx-rtd-theme.readthedocs.io/
MIT License
4.68k stars 1.72k forks source link

Clarify installation instructions #1222

Open astrojuanlu opened 2 years ago

astrojuanlu commented 2 years ago

As @evildmp noted, the installation docs say:

https://github.com/readthedocs/sphinx_rtd_theme/blob/b07560bf97dad3a4266f6145bd4b662ac708ab00/docs/installing.rst#L11-L22

However, just doing html_theme = 'sphinx_rtd_theme' works for most cases. There's a note below:

https://github.com/readthedocs/sphinx_rtd_theme/blob/b07560bf97dad3a4266f6145bd4b662ac708ab00/docs/installing.rst#L25-L29

but I don't understand what it means. Perhaps projects that want to opt-out from localization can use the simplified procedure? What am I missing here?

webknjaz commented 2 years ago

Perhaps projects that want to opt-out from localization can use the simplified procedure? What am I missing here?

It's not just localisation, it's also a few other compatibility shims: https://github.com/readthedocs/sphinx_rtd_theme/blob/73d1707/sphinx_rtd_theme/__init__.py#L51-L61.

But yes, strictly speaking, most of the theme will work w/o loading the extension because it's also declared as an entry point: https://github.com/readthedocs/sphinx_rtd_theme/blob/73d1707/setup.py#L116.