Issue #154: pulp_python docs should use the Sphinx RTD theme by default similar to Pulp platform - Python Support - Pulp

Actions

Send by e-mail Copy link

Issue #154

closed

pulp_python docs should use the Sphinx RTD theme by default similar to Pulp platform

Added by bmbouter about 9 years ago. Updated about 5 years ago.

Status:

CLOSED - CURRENTRELEASE

Priority:

Normal

Assignee:

bmbouter

Sprint/Milestone:

Start date:

Due date:

Estimated time:

Severity:

1. Low

Version - Python:

Platform Release:

Target Release - Python:

1.0.0

OS:

Triaged:

Yes

Groomed:

Sprint Candidate:

Tags:

Easy Fix, Pulp 2

Sprint:

Quarter:

Description

When building the docs you get something that is visually different from the docs hosted at RTD. I expect the locally build html docs to use the RTD Sphinx theme if it is installed. If it is not installed it should fall back to the default sphinx theme.

Actions

Copy link

Updated by bmbouter about 9 years ago

Severity set to Low

Actions

Copy link

Updated by bmbouter about 9 years ago

Status changed from ASSIGNED to POST

PR available at: https://github.com/pulp/pulp_python/pull/19

Actions

Copy link

Updated by bmbouter about 9 years ago

Status changed from POST to MODIFIED
Platform Release set to master

Merged to master.

Actions

Copy link

Updated by bmbouter about 9 years ago

QE steps to verify:

1) Ensure that you do not have sphinx-rtd-theme installed. `pip freeze | grep sphinx-rtd-theme | wc l` should report 0
2) build the docs locally
3) ensure the docs build with the default sphinx theme. Do this by seeing the look and feel.
4) install sphinx-rtd-theme using pip
5) make clean and make html to rebuild the docs
5) ensure that they have the same look and feel as http://pulp-python.readthedocs.org/en/latest/

Actions

Copy link