From a1598502bd65576e9e23959a0cf412add5de23b8 Mon Sep 17 00:00:00 2001 From: Akihiro Motoki Date: Thu, 6 Jul 2017 21:18:00 +0000 Subject: rearrange existing documentation to fit the new standard layout For more detail, see the doc migration spec: http://specs.openstack.org/openstack/docs-specs/specs/pike/os-manuals-migration.html There is also the recent status of the work posted in the dev ML: http://lists.openstack.org/pipermail/openstack-dev/2017-July/119221.html Change-Id: I1e728fc0bc671150d826747010eb980176f0cc13 --- doc/source/contributing.rst | 1 - doc/source/contributor/index.rst | 1 + doc/source/history.rst | 1 - doc/source/index.rst | 27 +++++---------------------- doc/source/install/index.rst | 12 ++++++++++++ doc/source/installation.rst | 12 ------------ doc/source/reference/index.rst | 9 +++++++++ doc/source/usage.rst | 25 ------------------------- doc/source/user/history.rst | 1 + doc/source/user/index.rst | 9 +++++++++ doc/source/user/usage.rst | 25 +++++++++++++++++++++++++ 11 files changed, 62 insertions(+), 61 deletions(-) delete mode 100644 doc/source/contributing.rst create mode 100644 doc/source/contributor/index.rst delete mode 100644 doc/source/history.rst create mode 100644 doc/source/install/index.rst delete mode 100644 doc/source/installation.rst create mode 100644 doc/source/reference/index.rst delete mode 100644 doc/source/usage.rst create mode 100644 doc/source/user/history.rst create mode 100644 doc/source/user/index.rst create mode 100644 doc/source/user/usage.rst (limited to 'doc') diff --git a/doc/source/contributing.rst b/doc/source/contributing.rst deleted file mode 100644 index 8cb3146..0000000 --- a/doc/source/contributing.rst +++ /dev/null @@ -1 +0,0 @@ -.. include:: ../../CONTRIBUTING.rst \ No newline at end of file diff --git a/doc/source/contributor/index.rst b/doc/source/contributor/index.rst new file mode 100644 index 0000000..b1cd2f3 --- /dev/null +++ b/doc/source/contributor/index.rst @@ -0,0 +1 @@ +.. include:: ../../../CONTRIBUTING.rst diff --git a/doc/source/history.rst b/doc/source/history.rst deleted file mode 100644 index 69ed4fe..0000000 --- a/doc/source/history.rst +++ /dev/null @@ -1 +0,0 @@ -.. include:: ../../ChangeLog diff --git a/doc/source/index.rst b/doc/source/index.rst index 41ea896..b5e6d74 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -8,29 +8,12 @@ and APIs. .. toctree:: :maxdepth: 2 - installation - usage - contributing + install/index + user/index + contributor/index + reference/index -Code Documentation -================== - -.. toctree:: - :maxdepth: 1 - - api/autoindex - -Release Notes -============= - -.. toctree:: - :maxdepth: 1 - - history - - -Indices and tables -================== +.. rubric:: Indices and tables * :ref:`genindex` * :ref:`modindex` diff --git a/doc/source/install/index.rst b/doc/source/install/index.rst new file mode 100644 index 0000000..e7a6f4d --- /dev/null +++ b/doc/source/install/index.rst @@ -0,0 +1,12 @@ +============ +Installation +============ + +At the command line:: + + $ pip install oslo.vmware + +Or, if you have virtualenvwrapper installed:: + + $ mkvirtualenv oslo.vmware + $ pip install oslo.vmware diff --git a/doc/source/installation.rst b/doc/source/installation.rst deleted file mode 100644 index e7a6f4d..0000000 --- a/doc/source/installation.rst +++ /dev/null @@ -1,12 +0,0 @@ -============ -Installation -============ - -At the command line:: - - $ pip install oslo.vmware - -Or, if you have virtualenvwrapper installed:: - - $ mkvirtualenv oslo.vmware - $ pip install oslo.vmware diff --git a/doc/source/reference/index.rst b/doc/source/reference/index.rst new file mode 100644 index 0000000..be6c6b7 --- /dev/null +++ b/doc/source/reference/index.rst @@ -0,0 +1,9 @@ +============= +API Reference +============= + +.. toctree:: + :maxdepth: 1 + :glob: + + api/* diff --git a/doc/source/usage.rst b/doc/source/usage.rst deleted file mode 100644 index 9561ffc..0000000 --- a/doc/source/usage.rst +++ /dev/null @@ -1,25 +0,0 @@ -======= - Usage -======= - -Example usage of getting a handle to a vSphere session and retrieving all the -ESX hosts in a server:: - - from oslo_vmware import api - from oslo_vmware import vim_util - - # Get a handle to a vSphere API session - session = api.VMwareAPISession( - '10.1.2.3', # vSphere host endpoint - 'administrator', # vSphere username - 'password', # vSphere password - 10, # Number of retries for connection failures in tasks - 0.1 # Poll interval for async tasks (in seconds) - ) - - # Example call to get all the managed objects of type "HostSystem" - # on the server. - result = session.invoke_api( - vim_util, # Handle to VIM utility module - 'get_objects', # API method name to invoke - session.vim, 'HostSystem', 100) # Params to API method (*args) diff --git a/doc/source/user/history.rst b/doc/source/user/history.rst new file mode 100644 index 0000000..f69be70 --- /dev/null +++ b/doc/source/user/history.rst @@ -0,0 +1 @@ +.. include:: ../../../ChangeLog diff --git a/doc/source/user/index.rst b/doc/source/user/index.rst new file mode 100644 index 0000000..b314802 --- /dev/null +++ b/doc/source/user/index.rst @@ -0,0 +1,9 @@ +================= +Using oslo.vmware +================= + +.. toctree:: + :maxdepth: 1 + + usage + history diff --git a/doc/source/user/usage.rst b/doc/source/user/usage.rst new file mode 100644 index 0000000..9561ffc --- /dev/null +++ b/doc/source/user/usage.rst @@ -0,0 +1,25 @@ +======= + Usage +======= + +Example usage of getting a handle to a vSphere session and retrieving all the +ESX hosts in a server:: + + from oslo_vmware import api + from oslo_vmware import vim_util + + # Get a handle to a vSphere API session + session = api.VMwareAPISession( + '10.1.2.3', # vSphere host endpoint + 'administrator', # vSphere username + 'password', # vSphere password + 10, # Number of retries for connection failures in tasks + 0.1 # Poll interval for async tasks (in seconds) + ) + + # Example call to get all the managed objects of type "HostSystem" + # on the server. + result = session.invoke_api( + vim_util, # Handle to VIM utility module + 'get_objects', # API method name to invoke + session.vim, 'HostSystem', 100) # Params to API method (*args) -- cgit v1.2.1