From 27b73ac55d269687c81845858d9142f1d849c38d Mon Sep 17 00:00:00 2001 From: Steve Martinelli Date: Sat, 17 Jan 2015 02:55:57 -0500 Subject: Fix doc building errors Addresses some of the issues that appeared when running tox -edocs Change-Id: I31133744ee0ddefa72c6590cb381de317e65633e --- doc/source/command-objects/aggregate.rst | 16 ++++++++-------- doc/source/command-objects/container.rst | 10 +++++----- doc/source/command-objects/object.rst | 20 ++++++++++---------- doc/source/command-objects/role.rst | 2 +- doc/source/command-objects/server.rst | 22 ++++++++++++++++++++++ 5 files changed, 46 insertions(+), 24 deletions(-) (limited to 'doc/source/command-objects') diff --git a/doc/source/command-objects/aggregate.rst b/doc/source/command-objects/aggregate.rst index 2a40d234..6a1dd908 100644 --- a/doc/source/command-objects/aggregate.rst +++ b/doc/source/command-objects/aggregate.rst @@ -12,7 +12,7 @@ aggregate add host Add host to aggregate -.. program aggregate add host +.. program:: aggregate add host .. code:: bash os aggregate add host @@ -33,7 +33,7 @@ aggregate create Create a new aggregate -.. program aggregate create +.. program:: aggregate create .. code:: bash os aggregate create @@ -58,7 +58,7 @@ aggregate delete Delete an existing aggregate -.. program aggregate delete +.. program:: aggregate delete .. code:: bash os aggregate delete @@ -73,7 +73,7 @@ aggregate list List all aggregates -.. program aggregate list +.. program:: aggregate list .. code:: bash os aggregate list @@ -88,7 +88,7 @@ aggregate remove host Remove host from aggregate -.. program aggregate remove host +.. program:: aggregate remove host .. code:: bash os aggregate remove host @@ -100,7 +100,7 @@ Remove host from aggregate Aggregate (name or ID) -.. option:: +.. describe:: Host to remove from :ref:`\ ` @@ -109,7 +109,7 @@ aggregate set Set aggregate properties -.. program aggregate set +.. program:: aggregate set .. code:: bash os aggregate set @@ -141,7 +141,7 @@ aggregate show Display aggregate details -.. program aggregate show +.. program:: aggregate show .. code:: bash os aggregate show diff --git a/doc/source/command-objects/container.rst b/doc/source/command-objects/container.rst index 845933d4..3372f4d9 100644 --- a/doc/source/command-objects/container.rst +++ b/doc/source/command-objects/container.rst @@ -15,7 +15,7 @@ Create new container os container create [ ...] -.. option:: +.. describe:: New container name(s) @@ -30,7 +30,7 @@ Delete container os container delete [ ...] -.. option:: +.. describe:: Container(s) to delete @@ -70,7 +70,7 @@ List containers List additional fields in output -.. options:: --all +.. option:: --all List all containers (default is 10000) @@ -85,7 +85,7 @@ Save container contents locally os container save -.. option:: +.. describe:: Container to save @@ -100,6 +100,6 @@ Display container details os container show [] -.. option:: +.. describe:: Container to display diff --git a/doc/source/command-objects/object.rst b/doc/source/command-objects/object.rst index c45c1051..25cf69e3 100644 --- a/doc/source/command-objects/object.rst +++ b/doc/source/command-objects/object.rst @@ -16,11 +16,11 @@ Upload object to container [ ...] -.. option:: +.. describe:: Container for new object -.. option:: +.. describe:: Local filename(s) to upload @@ -36,11 +36,11 @@ Delete object from container [ ...] -.. option:: +.. describe:: Delete object(s) from -.. option:: +.. describe:: Object(s) to delete @@ -86,11 +86,11 @@ List objects List additional fields in output -.. options:: --all +.. option:: --all List all objects in (default is 10000) -.. option:: +.. describe:: Container to list @@ -111,11 +111,11 @@ Save object locally Destination filename (defaults to object name) -.. option:: +.. describe:: Download from -.. option:: +.. describe:: Object to save @@ -131,10 +131,10 @@ Display object details -.. option:: +.. describe:: Display from -.. option:: +.. describe:: Object to display diff --git a/doc/source/command-objects/role.rst b/doc/source/command-objects/role.rst index 57161b06..02766b03 100644 --- a/doc/source/command-objects/role.rst +++ b/doc/source/command-objects/role.rst @@ -67,7 +67,7 @@ Delete role(s) os role delete [ ...] -.. option:: +.. describe:: Role to delete (name or ID) diff --git a/doc/source/command-objects/server.rst b/doc/source/command-objects/server.rst index 360ec24e..583acae0 100644 --- a/doc/source/command-objects/server.rst +++ b/doc/source/command-objects/server.rst @@ -9,6 +9,7 @@ server add security group Add security group to server +.. program:: server add security group .. code:: bash os server add security group @@ -28,6 +29,7 @@ server add volume Add volume to server +.. program:: server add volume .. code:: bash os server add volume @@ -52,6 +54,7 @@ server create Create a new server +.. program:: server create .. code:: bash os server create @@ -145,6 +148,7 @@ server delete Delete server(s) +.. program:: server delete .. code:: bash os server delete @@ -223,6 +227,7 @@ server lock Lock server +.. program:: server lock .. code:: bash os server lock @@ -237,6 +242,7 @@ server migrate Migrate server to different host +.. program:: server migrate .. code:: bash os server migrate @@ -279,6 +285,7 @@ server pause Pause server +.. program:: server pause .. code:: bash os server pause @@ -293,6 +300,7 @@ server reboot Perform a hard or soft server reboot +.. program:: server reboot .. code:: bash os server reboot @@ -321,6 +329,7 @@ server rebuild Rebuild server +.. program:: server rebuild .. code:: bash os server rebuild @@ -350,6 +359,7 @@ server remove security group Remove security group from server +.. program:: server remove security group .. code:: bash os server remove security group @@ -369,6 +379,7 @@ server remove volume Remove volume from server +.. program:: server remove volume .. code:: bash os server remove volume @@ -388,6 +399,7 @@ server rescue Put server in rescue mode +.. program:: server rescure .. code:: bash os server rescue @@ -402,6 +414,7 @@ server resize Scale server to a new flavor +.. program:: server resize .. code:: bash os server resize @@ -444,6 +457,7 @@ server resume Resume server +.. program:: server resume .. code:: bash os server resume @@ -458,6 +472,7 @@ server set Set server properties +.. program:: server set .. code:: bash os server set @@ -489,6 +504,7 @@ server show Show server details +.. program:: server show .. code:: bash os server show @@ -508,6 +524,7 @@ server ssh Ssh to server +.. program:: server ssh .. code:: bash os server ssh @@ -555,6 +572,7 @@ server suspend Suspend server +.. program:: server suspend .. code:: bash os server suspend @@ -569,6 +587,7 @@ server unlock Unlock server +.. program:: server unlock .. code:: bash os server unlock @@ -583,6 +602,7 @@ server unpause Unpause server +.. program:: server unpause .. code:: bash os server unpause @@ -597,6 +617,7 @@ server unrescue Restore server from rescue mode +.. program:: server unrescue .. code:: bash os server unrescue @@ -611,6 +632,7 @@ server unset Unset server properties +.. program:: server unset .. code:: bash os server unset -- cgit v1.2.1