From be10de4b91c46825cb0e0d895e1ec6304ba6562a Mon Sep 17 00:00:00 2001 From: "Jay S. Bryant" Date: Mon, 21 Aug 2017 13:56:27 -0500 Subject: [PATCH] [Doc Bld Fix] Add links to man page contents The pages under man/ had not been linked to from anywhere. This was causing Sphinx to issue warnings during build. This patch corrects that. There was also a 'todo' directive that wasn't valid that needed to be removed. This patch also corrects that. Change-Id: I8ab75b7be921a05e9e4eb023c4dfe90cf4404e6c --- doc/source/contributor/volume.rst | 3 ++- doc/source/index.rst | 11 +++++++++++ doc/source/install/index.rst | 1 + 3 files changed, 14 insertions(+), 1 deletion(-) diff --git a/doc/source/contributor/volume.rst b/doc/source/contributor/volume.rst index 02685bd128c..8316873f62b 100644 --- a/doc/source/contributor/volume.rst +++ b/doc/source/contributor/volume.rst @@ -18,7 +18,8 @@ Storage Volumes, Disks ====================== -.. todo:: rework after iSCSI merge (see 'Old Docs') (todd or vish) +.. note:: + TODO(todd or vish): rework after iSCSI merge (see 'Old Docs') (todd or vish) The :mod:`cinder.volume.manager` Module diff --git a/doc/source/index.rst b/doc/source/index.rst index 2a5ee12b772..309809e1cf9 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -90,6 +90,17 @@ on the python-cinderclient is in the `python-cinderclient repo`_. cli/cli-cinder-quotas cli/cli-cinder-scheduling +Man Pages +~~~~~~~~~ + +Additional 'man page' style documentation for Cinder may be seen below. + +.. toctree:: + :maxdepth: 2 + + man/cinder-manage + man/generalized_filters + Drivers ~~~~~~~ diff --git a/doc/source/install/index.rst b/doc/source/install/index.rst index 91e44d7c528..2ae54e06d04 100644 --- a/doc/source/install/index.rst +++ b/doc/source/install/index.rst @@ -19,6 +19,7 @@ For more information, see the .. toctree:: + overview get-started-block-storage index-obs index-rdo