openstack/python-manilaclient
Code Issues Proposed changes

Drop 'clidoc' from sphinx extensions

Browse Source 
Replace it with program-output from
sphinxcontrib-programoutput

Depends-On: https://review.openstack.org/595480
Change-Id: I9b14af568996cc1aaefaeb4d94fe36163c6cbbf2
This commit is contained in:
Goutham Pacha Ravi 2018-08-22 14:21:39 -07:00
parent 6d4e4a80c3
commit d146a345c7
6 changed files with 4 additions and 46 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
.gitignore vendored
View File

@ -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

1
doc/requirements.txt
View File

@ -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

4
doc/source/conf.py
View File

@ -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']

41
doc/source/exts/clidoc/__init__.py
View File

@ -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)

2
doc/source/user/shell.rst
View File

@ -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

1
lower-constraints.txt
View File

@ -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