user/cli doc is broken

Bug #1821389 reported by Goutham Pacha Ravi
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
python-manilaclient
Fix Released
High
Tom Barron

Bug Description

The document generated on https://docs.openstack.org/python-manilaclient/latest/user/shell.html
is broken. The sphinx directive to fetch the output of `manila help` isn't working.

It produces this text in the doc:

Run manila help to get a full list of all possible commands, and run manila help <command> to get detailed help for that command.

System Message: ERROR/6 (/home/zuul/src/git.openstack.org/openstack/python-manilaclient/doc/source/user/shell.rst, line 51)

Command 'manila --help' failed: [Errno 2] No such file or directory: 'manila': 'manila'

This used to work when the patch that introduced this merged: https://review.openstack.org/#/c/595362/

Tom Barron (tpb)
Changed in python-manilaclient:
assignee: nobody → Tom Barron (tpb)
importance: Undecided → High
tags: added: doc
Tom Barron (tpb)
Changed in python-manilaclient:
milestone: none → train-1
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix proposed to python-manilaclient (master)

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

Changed in python-manilaclient:
status: New → In Progress
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix merged to python-manilaclient (master)

Reviewed: https://review.openstack.org/645994
Committed: https://git.openstack.org/cgit/openstack/python-manilaclient/commit/?id=624265ade6b10f46e42cd9eb84c99b5e25264c31
Submitter: Zuul
Branch: master

commit 624265ade6b10f46e42cd9eb84c99b5e25264c31
Author: Tom Barron <email address hidden>
Date: Sat Mar 23 08:16:44 2019 -0400

    [doc] Fix command output generation

    Install manila command in the tox virtual environment
    for docs so sphinx can run ``manila`` to generate its
    help output.

    Closes-bug: #1821389
    Change-Id: I0bb221006842f3b40609753133c4203bc38fdffa

Changed in python-manilaclient:
status: In Progress → Fix Released
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix proposed to python-manilaclient (stable/stein)

Fix proposed to branch: stable/stein
Review: https://review.openstack.org/652780

Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix merged to python-manilaclient (stable/stein)

Reviewed: https://review.opendev.org/652780
Committed: https://git.openstack.org/cgit/openstack/python-manilaclient/commit/?id=8fd35a396e51f1c0d5d1f05a5e0e0feff739c5ae
Submitter: Zuul
Branch: stable/stein

commit 8fd35a396e51f1c0d5d1f05a5e0e0feff739c5ae
Author: Tom Barron <email address hidden>
Date: Sat Mar 23 08:16:44 2019 -0400

    [doc] Fix command output generation

    Install manila command in the tox virtual environment
    for docs so sphinx can run ``manila`` to generate its
    help output.

    Closes-bug: #1821389
    Change-Id: I0bb221006842f3b40609753133c4203bc38fdffa
    (cherry picked from commit 624265ade6b10f46e42cd9eb84c99b5e25264c31)

tags: added: in-stable-stein
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix included in openstack/python-manilaclient 1.28.0

This issue was fixed in the openstack/python-manilaclient 1.28.0 release.

Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix included in openstack/python-manilaclient stein-eol

This issue was fixed in the openstack/python-manilaclient stein-eol release.

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.