Skip to content

Commit

Permalink
[rtd] wave a dead chicken over conf.py in the hopes it helps something
Browse files Browse the repository at this point in the history
In 217c658, I changed conf.py so we always set html_theme
explicitly to rtd_sphinx_theme instead of letting RTD monkeypatch
it. This is necessary to prevent RTD's monkeypatch from blowing away
our html_theme_options. But somehow the effect it had was to prevent
our logo and favicon from appearing on RTD at all?!? (Before this they
both appeared but since html_theme_options["logo_only"] wasn't set we
got the logo + text; after we get just the text. wtf.)

This makes our conf.py stuff more closely match RTD's monkeypatch in
the hopes that that helps something, somehow.
  • Loading branch information
njsmith committed May 8, 2017
1 parent f6fad04 commit dd47b49
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -193,6 +193,14 @@ def getargspec(func):
import sphinx_rtd_theme
html_theme = 'sphinx_rtd_theme'
html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
# And this is a magic variable that RTD's monkeypatched conf.py would set if
# it were overridding our theme to be sphinx_rtd_theme
using_rtd_theme = True
# The next line is pure waving-a-dead-chicken-over-it; RTD's monkeypatched
# conf.py sets it, and we got weird rendering effects when we disabled the
# monkeypatching by setting html_theme = 'sphinx_rtd_theme' ourselves, so
# maybe it will help something.
html_style = None

# Theme options are theme-specific and customize the look and feel of a theme
# further. For a list of options available for each theme, see the
Expand Down

0 comments on commit dd47b49

Please sign in to comment.