cannot build doc from release tarball

Bug #1520096 reported by Bernhard M. Wiedemann on 2015-11-26
14
This bug affects 2 people
Affects Status Importance Assigned to Milestone
python-neutronclient
Medium
Akihiro Motoki
reno
Confirmed
High
Unassigned

Bug Description

when using the master release tarball and running
python setup.py build_sphinx

it fails, because the newly added reno module calls git
which returns an error, because there is no git tree
and that fails the build.

Akihiro Motoki (amotoki) wrote :

I think it is a good candidate of improvement in reno.

At the moment, the easiest way we can do in neutronclient side is not to include our release notes (release-notes directive) in our documentation and instead point the url http://docs.openstack.org/releasenotes/<project> instead.

Reno (or other tool chains) can be improved to generate release notes during "python setup.py sdist" or similar process
so that the documentation which contains 'releasenotes' sphinx directive can be generated even out of git tree.

Changed in python-neutronclient:
status: New → Triaged
importance: Undecided → Medium
Akihiro Motoki (amotoki) on 2015-12-03
Changed in python-neutronclient:
status: Triaged → Confirmed
Akihiro Motoki (amotoki) wrote :

Per Doug's mail on release notes http://lists.openstack.org/pipermail/openstack-dev/2015-November/080694.html,
the release notes and the normal developer documentation should be built separately.

Changed in python-neutronclient:
assignee: nobody → Akihiro Motoki (amotoki)

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

Changed in python-neutronclient:
status: Confirmed → In Progress

Reviewed: https://review.openstack.org/253100
Committed: https://git.openstack.org/cgit/openstack/python-neutronclient/commit/?id=800f35d8a5a99a67f27b8adf6b0c5046e748d49a
Submitter: Jenkins
Branch: master

commit 800f35d8a5a99a67f27b8adf6b0c5046e748d49a
Author: Akihiro Motoki <email address hidden>
Date: Fri Dec 4 02:25:31 2015 +0900

    Do not include reno releasenotes in normal documentation

    Per the recent release note guidelines for libraries [1],
    reno based release notes will be moved out from the normal docs.
    The previous (partial) release notes are also moved to
    releasenotes directory. The developer documentation now
    has a link to the releasenote web site.

    In addition, having reno directive in normal sphinx document
    prevents users from generating our docs from release tarballs.

    [1] http://lists.openstack.org/pipermail/openstack-dev/2015-November/080694.html

    Change-Id: I817f1a7331b8664486544c82e1a9a917864601bf
    Closes-Bug: #1520096

Changed in python-neutronclient:
status: In Progress → Fix Committed
Akihiro Motoki (amotoki) on 2015-12-09
Changed in python-neutronclient:
milestone: none → 4.0.0
Akihiro Motoki (amotoki) on 2016-01-06
Changed in python-neutronclient:
status: Fix Committed → Fix Released

This issue was fixed in the openstack/python-neutronclient 4.0.0 release.

We're working on a solution that will allow us to generate sdists with release notes included

Changed in reno:
status: New → Confirmed
importance: Undecided → High
Doug Hellmann (doug-hellmann) wrote :

The bug tracker for reno has moved to storyboard: https://storyboard.openstack.org/#!/project/933

To post a comment you must log in.
This report contains Public information  Edit
Everyone can see this information.

Other bug subscribers