From d363cc790187b872a2e04e4b56f94415bef41987 Mon Sep 17 00:00:00 2001 From: Goutham Pacha Ravi Date: Wed, 22 Aug 2018 22:11:11 -0700 Subject: [PATCH] Add sphinxcontrib-programoutput This sphinx extension provides a way to document CLI invocations in an up-to-date manner from release to release. For example, see the python-manilaclient change here [1] > Is the library actively maintained? Yes, The upstream code repository is maintained on GitHub, and has been quite stable. [2] > Is the library good code? Yes, and it also has continuous integration [3] > Is the library python 3 compatible? Yes, has been tested with python 3. [3] also shows python3 test runs. > Is the library license compatible? Yes, BSD. > Is the library already packaged in the distros we target (Ubuntu latest / Fedora latest)? Yes. Ubuntu [4] Fedora [5] Gentoo [6] SUSE [7] > Is the function of this library already covered by other libraries in global-requirements.txt? No > Is the library required for OpenStack project or related dev or infrastructure setup? Yes, see [1] for the change proposed to python-manilaclient for a sample change. We intend to use it in more places in the documentation soon. Also see [8] for the usage in a handful of OpenStack projects. > If the library release is managed by the Openstack release process does it use the cycle-with-intermediary release type? N/A > Do I need to update anything else? Upper-constraints.txt has been appropriately modified. [1] https://review.openstack.org/#/c/595362/ [2] https://github.com/NextThought/sphinxcontrib-programoutput [3] https://travis-ci.org/NextThought/sphinxcontrib-programoutput [4] https://packages.ubuntu.com/search?suite=bionic§ion=all&arch=any&keywords=programoutput&searchon=names [5] https://apps.fedoraproject.org/packages/s/programoutput [6] https://packages.gentoo.org/packages/dev-python/sphinxcontrib-programoutput [7] https://build.opensuse.org/package/show/devel:languages:python/python-sphinxcontrib-programoutput [8] http://codesearch.openstack.org/?q=programoutput&i=nope&files=&repos= Change-Id: I80b9d0b0f027bbffc9324030329dad3ad0a2ca5a --- global-requirements.txt | 1 + upper-constraints.txt | 1 + 2 files changed, 2 insertions(+) diff --git a/global-requirements.txt b/global-requirements.txt index 024ccebfda..ec9153e342 100644 --- a/global-requirements.txt +++ b/global-requirements.txt @@ -444,6 +444,7 @@ sphinxcontrib-fulltoc # Apache-2.0 sphinx-feature-classification # Apache-2.0 sphinxmark # Apache-2.0 sphinxcontrib.datatemplates # BSD License +sphinxcontrib-programoutput # BSD license stestr # Apache-2.0 sushy # Apache-2.0 testrepository # Apache-2.0/BSD diff --git a/upper-constraints.txt b/upper-constraints.txt index ae03c2253b..c9c845aa8f 100644 --- a/upper-constraints.txt +++ b/upper-constraints.txt @@ -506,6 +506,7 @@ Babel===2.6.0 logutils===0.3.5 scandir===1.7;python_version=='2.7' sphinxcontrib-fulltoc===1.2.0 +sphinxcontrib-programoutput===0.11 smmap2===2.0.4 greenlet===0.4.13 XStatic-Angular-Vis===4.16.0.0