Project

Profile

Help

Issue #154

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

Added by bmbouter almost 6 years ago. Updated over 1 year ago.

Status:
CLOSED - CURRENTRELEASE
Priority:
Normal
Assignee:
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:
No
Sprint Candidate:
No
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.

History

#1 Updated by bmbouter almost 6 years ago

  • Severity set to Low

#2 Updated by bmbouter almost 6 years ago

  • Status changed from ASSIGNED to POST

#3 Updated by bmbouter almost 6 years ago

  • Status changed from POST to MODIFIED
  • Platform Release set to master

Merged to master.

#4 Updated by bmbouter almost 6 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/

#5 Updated by bmbouter over 5 years ago

  • Severity changed from Low to 1. Low

#6 Updated by bmbouter over 5 years ago

  • Platform Release deleted (master)
  • Target Release - Python set to master

#7 Updated by rbarlow over 5 years ago

  • Status changed from MODIFIED to 5
  • Target Release - Python changed from master to 1.0.0

Fixed in 1.0.0-0.1.beta.

#8 Updated by bmbouter almost 5 years ago

  • Status changed from 5 to CLOSED - CURRENTRELEASE

#9 Updated by bmbouter over 1 year ago

  • Tags Pulp 2 added

Please register to edit this issue

Also available in: Atom PDF