If you think a bug might affect users in the 57 release, please set the correct tracking and status flags for Release Management.

Update the sphinx config to use the Read the Docs theme for local builds too

RESOLVED FIXED

Status

Tree Management
Treeherder: Docs & Development
P5
enhancement
RESOLVED FIXED
3 years ago
2 years ago

People

(Reporter: jfrench, Assigned: emorley)

Tracking

Details

(URL)

(Reporter)

Description

3 years ago
So in fixing another readthedocs bug, I built using the RTD theme which makes a local docs build look like the live version. I found a bit at the bottom of this support page which allows that.
https://docs.readthedocs.org/en/latest/theme.html

A default build from our repos doesn't do this, so the user gets the default theme, which is very different looking in size and layout. 

As a nicety we could perhaps, in our config.py:

- test for the installation of sphinx_rtd_theme
- if installed use it
- if not installed let the user know gracefully
- fall back on the default theme and build it

We could do this for both treeherder-service and treeherder-ui in that scenario.

Apologies if I've missed something here, in my newbie-ness :)
(Assignee)

Comment 1

3 years ago
Perhaps lets copy https://hg.mozilla.org/hgcustom/version-control-tools/rev/4001e44585e3 ? :-)
(Assignee)

Updated

3 years ago
Component: Treeherder → Treeherder: Docs & Development
Priority: P5 → P4
(Assignee)

Updated

3 years ago
Priority: P4 → P5

Comment 2

2 years ago
Commit pushed to master at https://github.com/mozilla/treeherder

https://github.com/mozilla/treeherder/commit/76c5b0de693912a2c1bf4ee83157bfa196ed254f
Bug 1085579 - Docs: Use the Read the Docs theme for local builds too

Using the instructions from:
https://docs.readthedocs.org/en/latest/theme.html#how-do-i-use-this-locally-and-on-read-the-docs
(Assignee)

Updated

2 years ago
Assignee: nobody → emorley
Status: NEW → RESOLVED
Last Resolved: 2 years ago
Resolution: --- → FIXED
Summary: Possibly update sphinx config to use the RTD theme on local builds → Update the sphinx config to use the Read the Docs theme for local builds too
You need to log in before you can comment on or make changes to this bug.