Drop 'clidoc' from sphinx extensions

Replace it with program-output from
sphinxcontrib-programoutput

Depends-On: https://review.openstack.org/595480
Change-Id: I9b14af568996cc1aaefaeb4d94fe36163c6cbbf2

.gitignore

@@ -17,6 +17,5 @@ setuptools_git*.egg
 setuptools_git*.egg
 AUTHORS
 ChangeLog
-doc/source/manila_cli_output.rst.inc
 # Files created by releasenotes build
 releasenotes/build

doc/requirements.txt

@@ -4,3 +4,4 @@
 openstackdocstheme>=1.18.1 # Apache-2.0
 sphinx!=1.6.6,!=1.6.7,>=1.6.2 # BSD
 reno>=2.5.0 # Apache-2.0
+sphinxcontrib-programoutput>=0.11  # BSD

doc/source/conf.py

@@ -25,15 +25,13 @@ import openstackdocstheme
 BASE_DIR = os.path.dirname(os.path.abspath(__file__))
 ROOT = os.path.abspath(os.path.join(BASE_DIR, "..", ".."))
 sys.path.insert(0, ROOT)
-# path to local extensions
-sys.path.append(os.path.abspath('exts'))
 
 # -- General configuration ----------------------------------------------------
 
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions
 # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
-extensions = ['sphinx.ext.autodoc', 'openstackdocstheme', 'clidoc']
+extensions = ['sphinx.ext.autodoc', 'openstackdocstheme', 'sphinxcontrib.programoutput']
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']

doc/source/exts/clidoc/__init__.py

@@ -1,41 +0,0 @@
-# Copyright 2014 SUSE Linux GmbH
-#
-# Licensed under the Apache License, Version 2.0 (the "License"); you may
-# not use this file except in compliance with the License. You may obtain
-# a copy of the License at
-#
-# http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
-# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
-# License for the specific language governing permissions and limitations
-# under the License.
-
-import os
-import sys
-import cStringIO
-
-
-def _get_cli_output():
-    stdout_org = sys.stdout
-    sys.stdout = output = cStringIO.StringIO()
-    from manilaclient import shell
-    shell = shell.OpenStackManilaShell()
-    shell.main(None)
-    sys.stdout = stdout_org
-    output.seek(0)
-    return map(lambda x: "    %s" % x, output)
-
-
-def builder_inited(app):
-    # generate the missing rst files
-    with open(os.path.join(app.env.srcdir, "cli/manila_cli_output.rst.inc"), "w") as f:
-        f.write("``manila help``::\n\n")
-        f.write("\n".join(_get_cli_output()))
-        f.write("\n")
-
-
-def setup(app):
-    app.connect('builder-inited', builder_inited)
-

doc/source/user/shell.rst

@@ -48,4 +48,4 @@ Run :program:`manila help` to get a full list of all possible commands,
 and run :program:`manila help <command>` to get detailed help for that
 command.
 
-.. include:: ../cli/manila_cli_output.rst.inc
+.. program-output:: manila --help

lower-constraints.txt

@@ -84,6 +84,7 @@ six==1.10.0
 snowballstemmer==1.2.1
 Sphinx==1.6.5
 sphinxcontrib-websupport==1.0.1
+sphinxcontrib-programoutput==0.11
 stestr==1.0.0
 stevedore==1.20.0
 tempest==17.1.0