openstack/python-openstackclient
Code Issues Proposed changes

Fix doc building errors

Browse Source 
Addresses some of the issues that appeared when running tox -edocs

Change-Id: I31133744ee0ddefa72c6590cb381de317e65633e
This commit is contained in:
Steve Martinelli
2015-01-17 02:55:57 -05:00
parent b9e50a716d
commit 27b73ac55d
6 changed files with 50 additions and 28 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
doc/source/command-objects/aggregate.rst
View File

@@ -12,7 +12,7 @@ aggregate add host
Add host to aggregate Add host to aggregate
.. program aggregate add host .. program:: aggregate add host
.. code:: bash .. code:: bash
os aggregate add host os aggregate add host
@@ -33,7 +33,7 @@ aggregate create
Create a new aggregate Create a new aggregate
.. program aggregate create .. program:: aggregate create
.. code:: bash .. code:: bash
os aggregate create os aggregate create
@@ -58,7 +58,7 @@ aggregate delete
Delete an existing aggregate Delete an existing aggregate
.. program aggregate delete .. program:: aggregate delete
.. code:: bash .. code:: bash
os aggregate delete os aggregate delete
@@ -73,7 +73,7 @@ aggregate list
List all aggregates List all aggregates
.. program aggregate list .. program:: aggregate list
.. code:: bash .. code:: bash
os aggregate list os aggregate list
@@ -88,7 +88,7 @@ aggregate remove host
Remove host from aggregate Remove host from aggregate
.. program aggregate remove host .. program:: aggregate remove host
.. code:: bash .. code:: bash
os aggregate remove host os aggregate remove host
@@ -100,7 +100,7 @@ Remove host from aggregate
Aggregate (name or ID) Aggregate (name or ID)
.. option:: <host> .. describe:: <host>
Host to remove from :ref:`\<aggregate\> <aggregate_remove_host-aggregate>` Host to remove from :ref:`\<aggregate\> <aggregate_remove_host-aggregate>`
@@ -109,7 +109,7 @@ aggregate set
Set aggregate properties Set aggregate properties
.. program aggregate set .. program:: aggregate set
.. code:: bash .. code:: bash
os aggregate set os aggregate set
@@ -141,7 +141,7 @@ aggregate show
Display aggregate details Display aggregate details
.. program aggregate show .. program:: aggregate show
.. code:: bash .. code:: bash
os aggregate show os aggregate show

10
doc/source/command-objects/container.rst
View File

@@ -15,7 +15,7 @@ Create new container
os container create os container create
<container-name> [<container-name> ...] <container-name> [<container-name> ...]
.. option:: <container-name> .. describe:: <container-name>
New container name(s) New container name(s)
@@ -30,7 +30,7 @@ Delete container
os container delete os container delete
<container> [<container> ...] <container> [<container> ...]
.. option:: <container> .. describe:: <container>
Container(s) to delete Container(s) to delete
@@ -70,7 +70,7 @@ List containers
List additional fields in output List additional fields in output
.. options:: --all .. option:: --all
List all containers (default is 10000) List all containers (default is 10000)
@@ -85,7 +85,7 @@ Save container contents locally
os container save os container save
<container> <container>
.. option:: <container> .. describe:: <container>
Container to save Container to save
@@ -100,6 +100,6 @@ Display container details
os container show os container show
[<container>] [<container>]
.. option:: <container> .. describe:: <container>
Container to display Container to display

20
doc/source/command-objects/object.rst
View File

@@ -16,11 +16,11 @@ Upload object to container
<container> <container>
<filename> [<filename> ...] <filename> [<filename> ...]
.. option:: <container> .. describe:: <container>
Container for new object Container for new object
.. option:: <filename> .. describe:: <filename>
Local filename(s) to upload Local filename(s) to upload
@@ -36,11 +36,11 @@ Delete object from container
<container> <container>
<object> [<object> ...] <object> [<object> ...]
.. option:: <container> .. describe:: <container>
Delete object(s) from <container> Delete object(s) from <container>
.. option:: <object> .. describe:: <object>
Object(s) to delete Object(s) to delete
@@ -86,11 +86,11 @@ List objects
List additional fields in output List additional fields in output
.. options:: --all .. option:: --all
List all objects in <container> (default is 10000) List all objects in <container> (default is 10000)
.. option:: <container> .. describe:: <container>
Container to list Container to list
@@ -111,11 +111,11 @@ Save object locally
Destination filename (defaults to object name) Destination filename (defaults to object name)
.. option:: <container> .. describe:: <container>
Download <object> from <container> Download <object> from <container>
.. option:: <object> .. describe:: <object>
Object to save Object to save
@@ -131,10 +131,10 @@ Display object details
<container> <container>
<object> <object>
.. option:: <container> .. describe:: <container>
Display <object> from <container> Display <object> from <container>
.. option:: <object> .. describe:: <object>
Object to display Object to display

2
doc/source/command-objects/role.rst
View File

@@ -67,7 +67,7 @@ Delete role(s)
os role delete os role delete
<role> [<role> ...] <role> [<role> ...]
.. option:: <role> .. describe:: <role>
Role to delete (name or ID) Role to delete (name or ID)

22
doc/source/command-objects/server.rst
View File

@@ -9,6 +9,7 @@ server add security group
Add security group to server Add security group to server
.. program:: server add security group
.. code:: bash .. code:: bash
os server add security group os server add security group
@@ -28,6 +29,7 @@ server add volume
Add volume to server Add volume to server
.. program:: server add volume
.. code:: bash .. code:: bash
os server add volume os server add volume
@@ -52,6 +54,7 @@ server create
Create a new server Create a new server
.. program:: server create
.. code:: bash .. code:: bash
os server create os server create
@@ -145,6 +148,7 @@ server delete
Delete server(s) Delete server(s)
.. program:: server delete
.. code:: bash .. code:: bash
os server delete os server delete
@@ -223,6 +227,7 @@ server lock
Lock server Lock server
.. program:: server lock
.. code:: bash .. code:: bash
os server lock os server lock
@@ -237,6 +242,7 @@ server migrate
Migrate server to different host Migrate server to different host
.. program:: server migrate
.. code:: bash .. code:: bash
os server migrate os server migrate
@@ -279,6 +285,7 @@ server pause
Pause server Pause server
.. program:: server pause
.. code:: bash .. code:: bash
os server pause os server pause
@@ -293,6 +300,7 @@ server reboot
Perform a hard or soft server reboot Perform a hard or soft server reboot
.. program:: server reboot
.. code:: bash .. code:: bash
os server reboot os server reboot
@@ -321,6 +329,7 @@ server rebuild
Rebuild server Rebuild server
.. program:: server rebuild
.. code:: bash .. code:: bash
os server rebuild os server rebuild
@@ -350,6 +359,7 @@ server remove security group
Remove security group from server Remove security group from server
.. program:: server remove security group
.. code:: bash .. code:: bash
os server remove security group os server remove security group
@@ -369,6 +379,7 @@ server remove volume
Remove volume from server Remove volume from server
.. program:: server remove volume
.. code:: bash .. code:: bash
os server remove volume os server remove volume
@@ -388,6 +399,7 @@ server rescue
Put server in rescue mode Put server in rescue mode
.. program:: server rescure
.. code:: bash .. code:: bash
os server rescue os server rescue
@@ -402,6 +414,7 @@ server resize
Scale server to a new flavor Scale server to a new flavor
.. program:: server resize
.. code:: bash .. code:: bash
os server resize os server resize
@@ -444,6 +457,7 @@ server resume
Resume server Resume server
.. program:: server resume
.. code:: bash .. code:: bash
os server resume os server resume
@@ -458,6 +472,7 @@ server set
Set server properties Set server properties
.. program:: server set
.. code:: bash .. code:: bash
os server set os server set
@@ -489,6 +504,7 @@ server show
Show server details Show server details
.. program:: server show
.. code:: bash .. code:: bash
os server show os server show
@@ -508,6 +524,7 @@ server ssh
Ssh to server Ssh to server
.. program:: server ssh
.. code:: bash .. code:: bash
os server ssh os server ssh
@@ -555,6 +572,7 @@ server suspend
Suspend server Suspend server
.. program:: server suspend
.. code:: bash .. code:: bash
os server suspend os server suspend
@@ -569,6 +587,7 @@ server unlock
Unlock server Unlock server
.. program:: server unlock
.. code:: bash .. code:: bash
os server unlock os server unlock
@@ -583,6 +602,7 @@ server unpause
Unpause server Unpause server
.. program:: server unpause
.. code:: bash .. code:: bash
os server unpause os server unpause
@@ -597,6 +617,7 @@ server unrescue
Restore server from rescue mode Restore server from rescue mode
.. program:: server unrescue
.. code:: bash .. code:: bash
os server unrescue os server unrescue
@@ -611,6 +632,7 @@ server unset
Unset server properties Unset server properties
.. program:: server unset
.. code:: bash .. code:: bash
os server unset os server unset

8
doc/source/humaninterfaceguide.rst
View File

@@ -53,7 +53,7 @@ focusing on common uses of the system rather than adding complexity to support
functionality that is rarely used. functionality that is rarely used.
Consistency Consistency
=========== -----------
Consistency between OpenStack experiences will ensure that the command line Consistency between OpenStack experiences will ensure that the command line
interface feels like a single experience instead of a jumble of disparate interface feels like a single experience instead of a jumble of disparate
@@ -72,7 +72,7 @@ Example Review Criteria
* Does the design use command elements (options and arguments) as defined? * Does the design use command elements (options and arguments) as defined?
(See Core Elements.) (See Core Elements.)
* Can any newly proposed command elements (actions or subjects) be accomplished * Can any newly proposed command elements (actions or subjects) be accomplished
with existing elemetns? with existing elements?
* Does the design adhere to the structural model of the core experience? * Does the design adhere to the structural model of the core experience?
(See Core Architecture.) (See Core Architecture.)
@@ -89,7 +89,7 @@ nonessential data, overabundance of possible actions, etc. Designs should
focus on the intent of the command, requiring only the necessary components focus on the intent of the command, requiring only the necessary components
and either removing superfluous elements or making and either removing superfluous elements or making
them accessible through optional arguments. An example of this principle occurs them accessible through optional arguments. An example of this principle occurs
in OpenStack’s use of tables: only the most often used columns are shown by in OpenStack's use of tables: only the most often used columns are shown by
default. Further data may be accessed through the output control options, default. Further data may be accessed through the output control options,
allowing users to specify the types of data that they find useful in their allowing users to specify the types of data that they find useful in their
day-to-day work. day-to-day work.
@@ -107,7 +107,7 @@ User-Centered Design
-------------------- --------------------
Commands should be design based on how a user will interact with the system Commands should be design based on how a user will interact with the system
and not how the system’s backend is organized. While database structures and and not how the system's backend is organized. While database structures and
APIs may define what is possible, they often do not define good user APIs may define what is possible, they often do not define good user
experience; consider user goals and the way in which users will want to experience; consider user goals and the way in which users will want to
interact with their data, then design for these work flows and mold the interact with their data, then design for these work flows and mold the