openstack/python-ironicclient
Code Issues Proposed changes
324fa6d22e
python-ironicclient/doc/source/index.rst

30 lines
602 B
ReStructuredText
Raw Normal View History

Add main developer page This adds the main ('index') page for developers (to be available at http://docs.openstack.org/developer/python-ironicclient/). It has minimal information, and is a place holder so that we can start adding documentation. This also fixes issues with 'python setup.py build_sphinx': - was getting "error: 'source_dir' must be a directory name" because sphinx 1.2b3 was being installed instead of 1.1.2 (see https://bugs.launchpad.net/openstack-ci/+bug/1259511) - was getting "sphinx.errors.ExtensionError: Could not import extension oslo.sphinx (exception: No module named sphinx)" - was complaining about missing '_theme' (oslosphinx has the theme) Change-Id: I47ad7e10c20b80a99ae36755b2f7f67c080676fd Partial-Bug: #1300990
2014-04-01 20:28:46 +00:00
===========================================
Python Bindings to the OpenStack Ironic API
===========================================
This is a client for OpenStack `Ironic`_ API. There's a Python API
Add documentation for ironic CLI Adds a short description about how to get started with the ironic CLI. Change-Id: I86247c36d9c3ce482dde009bef7e59fcdc493c64 Partial-Bug: #1300990
2014-04-08 19:14:04 +00:00
(the `ironicclient` modules), and a command-line interface (installed as
Add main developer page This adds the main ('index') page for developers (to be available at http://docs.openstack.org/developer/python-ironicclient/). It has minimal information, and is a place holder so that we can start adding documentation. This also fixes issues with 'python setup.py build_sphinx': - was getting "error: 'source_dir' must be a directory name" because sphinx 1.2b3 was being installed instead of 1.1.2 (see https://bugs.launchpad.net/openstack-ci/+bug/1259511) - was getting "sphinx.errors.ExtensionError: Could not import extension oslo.sphinx (exception: No module named sphinx)" - was complaining about missing '_theme' (oslosphinx has the theme) Change-Id: I47ad7e10c20b80a99ae36755b2f7f67c080676fd Partial-Bug: #1300990
2014-04-01 20:28:46 +00:00
`ironic`).
Contents
========
.. toctree::
:maxdepth: 1
Adds documentation for ironicclient API Adds some documentation on how to use the ironicclient API. Describes how to get a client object and has examples of a few ironic operations. The ironicclient modules are listed. Change-Id: Ic7c739fb5722b40c308b90c27178d937cad41028 Partial-Bug: #1300990
2014-04-03 16:49:31 +00:00
api_v1
Add documentation for ironic CLI Adds a short description about how to get started with the ironic CLI. Change-Id: I86247c36d9c3ce482dde009bef7e59fcdc493c64 Partial-Bug: #1300990
2014-04-08 19:14:04 +00:00
cli
Documentation for contributors Adds documentation for contributors, which describes how to get started. It mentions licence agreement, launchpad ID, and includes links to project-related information. Change-Id: I47423c9f2cdfd708c8cb45d4284c5af16d598153 Partial-Bug: #1300990
2014-04-03 16:16:31 +00:00
contributing
Add documentation on how to run tests Added a testing page to the documentation. This includes information on: * Running PEP8 checks * Running unit tests * Running functional tests Closes-bug:#1511731 Change-Id: I4a5cf4be98f32455e36ea7d6a45b18afca043809
2015-11-02 16:16:59 +02:00
testing
Add release note link for client release notes Add a link to client release notes to the index page. Change-Id: I871aace4e255d400f0a75318688926e40f95b551
2016-07-14 22:43:13 -07:00
Release Notes <http://docs.openstack.org/releasenotes/python-ironicclient/>
Add main developer page This adds the main ('index') page for developers (to be available at http://docs.openstack.org/developer/python-ironicclient/). It has minimal information, and is a place holder so that we can start adding documentation. This also fixes issues with 'python setup.py build_sphinx': - was getting "error: 'source_dir' must be a directory name" because sphinx 1.2b3 was being installed instead of 1.1.2 (see https://bugs.launchpad.net/openstack-ci/+bug/1259511) - was getting "sphinx.errors.ExtensionError: Could not import extension oslo.sphinx (exception: No module named sphinx)" - was complaining about missing '_theme' (oslosphinx has the theme) Change-Id: I47ad7e10c20b80a99ae36755b2f7f67c080676fd Partial-Bug: #1300990
2014-04-01 20:28:46 +00:00
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
.. _Ironic: https://wiki.openstack.org/wiki/Ironic
Copy Permalink