PBR

PBR doesn't support builder option for build_sphinx command

Bug #1447666 reported by Kenneth Koski
12
This bug affects 2 people
Affects Status Importance Assigned to Milestone
PBR
Won't Fix
High
Unassigned

Bug Description

I'm trying to generate a pdf version of the documentation for a project that uses pbr. This is the command that I'm using to do that:

    python setup.py build_sphinx --builder=pdf

According to the help for that command, that should work. However, HTML and man documentation are the only types that are ever generated. It appears that this is due to pbr intercepting the build_sphinx command, with the subclass located here:

https://github.com/openstack-dev/pbr/blob/master/pbr/builddoc.py#L67

There appears to be some attempt at making the option configurable, as seen later in the file:

https://github.com/openstack-dev/pbr/blob/master/pbr/builddoc.py#L201

But I can't seem to figure out how that might be set from the command line. Running "python setup.py build_sphinx -b man,pdf" didn't change the default builder options.

Tags: pbr sphinxdoc
Revision history for this message
Robert Collins (lifeless) wrote :

hmm, I'm not sure sorry. I'll see if I can get someone more familiar with the sphinx stuff to look

Changed in pbr:
status: New → Confirmed
importance: Undecided → High
Revision history for this message
Monty Taylor (mordred) wrote :

This is a bug for sure. we should honor the command line when it's given.

Changed in pbr:
status: Confirmed → Triaged
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix proposed to pbr (master)

Fix proposed to branch: master
Review: https://review.openstack.org/178878

Changed in pbr:
assignee: nobody → Monty Taylor (mordred)
status: Triaged → In Progress
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Change abandoned on pbr (master)

Change abandoned by Monty Taylor (<email address hidden>) on branch: master
Review: https://review.openstack.org/178878

Changed in pbr:
status: In Progress → Confirmed
Revision history for this message
Stephen Finucane (stephenfinucane) wrote :

We've determined that we're simply going to remove this feature in a future MAJOR release (likely 5.0). As such, I'm going to close this as won't fix.

Changed in pbr:
assignee: Monty Taylor (mordred) → nobody
status: Confirmed → Won't Fix
To post a comment you must log in.
This report contains Public information  
Everyone can see this information.

Other bug subscribers

Remote bug watches

Bug watches keep track of this bug in other bug trackers.