diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/requirements.txt | 4 | ||||
| -rw-r--r-- | doc/source/cli/details.rst | 10 | ||||
| -rw-r--r-- | doc/source/conf.py | 64 |
3 files changed, 55 insertions, 23 deletions
diff --git a/doc/requirements.txt b/doc/requirements.txt index 077e855..bf81d84 100644 --- a/doc/requirements.txt +++ b/doc/requirements.txt @@ -2,7 +2,7 @@ # of appearance. Changing the order has an impact on the overall integration # process, which may cause wedges in the gate later. # These are needed for docs generation -openstackdocstheme>=1.18.1 # Apache-2.0 +openstackdocstheme>=1.20.0 # Apache-2.0 reno>=2.5.0 # Apache-2.0 sphinx!=1.6.6,!=1.6.7,>=1.6.2,<2.0.0;python_version=='2.7' # BSD -sphinx!=1.6.6,!=1.6.7,>=1.6.2;python_version>='3.4' # BSD +sphinx!=1.6.6,!=1.6.7,!=2.1.0,>=1.6.2;python_version>='3.4' # BSD diff --git a/doc/source/cli/details.rst b/doc/source/cli/details.rst index 87e18f5..9ced4c6 100644 --- a/doc/source/cli/details.rst +++ b/doc/source/cli/details.rst @@ -23,8 +23,6 @@ Block Storage service (cinder) command-line client The cinder client is the command-line interface (CLI) for the Block Storage service (cinder) API and its extensions. -This chapter documents :command:`cinder` version ``2.2.0``. - For help on a specific :command:`cinder` command, enter: .. code-block:: console @@ -693,14 +691,6 @@ cinder usage ``rename`` Renames a volume. -``replication-promote`` - Promote a secondary volume to primary for a - relationship. - -``replication-reenable`` - Sync the secondary volume with primary for a - relationship. - ``reset-state`` Explicitly updates the entity state in the Cinder database. diff --git a/doc/source/conf.py b/doc/source/conf.py index 3cfc842..6642cbf 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -14,7 +14,7 @@ import os import sys -import pbr.version +import openstackdocstheme sys.setrecursionlimit(4000) @@ -48,17 +48,12 @@ source_suffix = '.rst' master_doc = 'index' # General information about the project. -project = 'python-cinderclient' copyright = 'OpenStack Contributors' -# The version info for the project you're documenting, acts as replacement for -# |version| and |release|, also used in various other places throughout the -# built documents. -version_info = pbr.version.VersionInfo('python-cinderclient') -# The short X.Y version. -version = version_info.version_string() -# The full version, including alpha/beta/rc tags. -release = version_info.release_string() +# done by the openstackdocstheme ext +# project = 'python-cinderclient' +# version = version_info.version_string() +# release = version_info.release_string() # List of directories, relative to source directory, that shouldn't be searched # for source files. @@ -84,7 +79,7 @@ html_theme = 'openstackdocs' # If not '', a 'Last updated on:' timestamp is inserted at every page bottom, # using the given strftime format. # html_last_updated_fmt = '%b %d, %Y' -html_last_updated_fmt = '%Y-%m-%d %H:%M' +# html_last_updated_fmt = '%Y-%m-%d %H:%M' # -- Options for manual page output ------------------------------------------ @@ -98,3 +93,50 @@ man_pages = [ repository_name = 'openstack/python-cinderclient' bug_project = 'cinderclient' bug_tag = '' + + +# -- Options for LaTeX output ------------------------------------------------- + +# The paper size ('letter' or 'a4'). +# latex_paper_size = 'letter' + +# The font size ('10pt', '11pt' or '12pt'). +# latex_font_size = '10pt' + +# Grouping the document tree into LaTeX files. List of tuples +# (source start file, target name, title, author, documentclass +# [howto/manual]). +latex_documents = [ + ('index', 'doc-python-cinderclient.tex', u'Cinder Client Documentation', + u'Cinder Contributors', 'manual'), +] + +# The name of an image file (relative to this directory) to place at the top of +# the title page. +# latex_logo = None + +# For "manual" documents, if this is true, then toplevel headings are parts, +# not chapters. +# latex_use_parts = False + +# Additional stuff for the LaTeX preamble. +# latex_preamble = '' + +# Documents to append as an appendix to all manuals. +# latex_appendices = [] + +# If false, no module index is generated. +# latex_use_modindex = True + +# Disable usage of xindy https://bugzilla.redhat.com/show_bug.cgi?id=1643664 +latex_use_xindy = False + +latex_domain_indices = False + +latex_elements = { + 'makeindex': '', + 'printindex': '', + 'preamble': r'\setcounter{tocdepth}{3}', +} + +latex_additional_files = ['cinderclient.sty'] |