diff --git a/.gitignore b/.gitignore index 23428d9a7..6bd7fd745 100644 --- a/.gitignore +++ b/.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 diff --git a/doc/requirements.txt b/doc/requirements.txt index a5c5dcb9f..4d764e135 100644 --- a/doc/requirements.txt +++ b/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 diff --git a/doc/source/conf.py b/doc/source/conf.py index 25430d86a..742cd4f70 100644 --- a/doc/source/conf.py +++ b/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'] diff --git a/doc/source/exts/clidoc/__init__.py b/doc/source/exts/clidoc/__init__.py deleted file mode 100644 index 0d47c11c6..000000000 --- a/doc/source/exts/clidoc/__init__.py +++ /dev/null @@ -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) - diff --git a/doc/source/user/shell.rst b/doc/source/user/shell.rst index f8e4174a3..d1b81e10e 100644 --- a/doc/source/user/shell.rst +++ b/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 ` to get detailed help for that command. -.. include:: ../cli/manila_cli_output.rst.inc +.. program-output:: manila --help diff --git a/lower-constraints.txt b/lower-constraints.txt index 843378db1..31c3e0998 100644 --- a/lower-constraints.txt +++ b/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