rearrange existing documentation to fit the new standard layout
Change-Id: I91657e96ef29f8b36b2089a11c9c4966418cfcdb Depends-On: Ia750cb049c0f53a234ea70ce1f2bbbb7a2aa9454 Signed-off-by: Doug Hellmann <doug@doughellmann.com>
This commit is contained in:
parent
2c9d95912e
commit
bdfa70956f
|
@ -16,7 +16,7 @@ ChangeLog
|
||||||
dist
|
dist
|
||||||
# Doc related
|
# Doc related
|
||||||
doc/build
|
doc/build
|
||||||
doc/source/api/
|
doc/source/reference/api/
|
||||||
# Development environment files
|
# Development environment files
|
||||||
.project
|
.project
|
||||||
.pydevproject
|
.pydevproject
|
||||||
|
|
|
@ -1 +0,0 @@
|
||||||
.. include:: ../../ChangeLog
|
|
|
@ -37,7 +37,6 @@ extensions = ['sphinx.ext.autodoc',
|
||||||
'sphinx.ext.doctest',
|
'sphinx.ext.doctest',
|
||||||
'sphinx.ext.todo',
|
'sphinx.ext.todo',
|
||||||
'oslosphinx',
|
'oslosphinx',
|
||||||
'ext.apidoc',
|
|
||||||
]
|
]
|
||||||
|
|
||||||
# Add any paths that contain templates here, relative to this directory.
|
# Add any paths that contain templates here, relative to this directory.
|
||||||
|
|
|
@ -0,0 +1,19 @@
|
||||||
|
==============
|
||||||
|
Contributing
|
||||||
|
==============
|
||||||
|
|
||||||
|
osc-lib utilizes all of the usual OpenStack processes and requirements for
|
||||||
|
contributions. The code is hosted `on OpenStack's Git server`_. `Bug reports`_
|
||||||
|
and `blueprints`_ may be submitted to the :code:`python-openstackclient` project
|
||||||
|
on `Launchpad`_. Code may be submitted to the
|
||||||
|
:code:`openstack/osc-lib` project using `Gerrit`_.
|
||||||
|
Developers may also be found in the `IRC channel`_ ``#openstack-sdks``.
|
||||||
|
|
||||||
|
.. _`on OpenStack's Git server`: https://git.openstack.org/cgit/openstack/python-openstackclient/tree
|
||||||
|
.. _Launchpad: https://launchpad.net/python-openstackclient
|
||||||
|
.. _Gerrit: http://docs.openstack.org/infra/manual/developers.html#development-workflow
|
||||||
|
.. _Bug reports: https://bugs.launchpad.net/python-openstackclient/+bugs
|
||||||
|
.. _blueprints: https://blueprints.launchpad.net/python-openstackclient
|
||||||
|
.. _PyPi: https://pypi.python.org/pypi/osc-lib
|
||||||
|
.. _tarball: http://tarballs.openstack.org/osc-lib
|
||||||
|
.. _IRC channel: https://wiki.openstack.org/wiki/IRC
|
|
@ -8,36 +8,11 @@ is a package of common support modules for writing OSC plugins.
|
||||||
Contents:
|
Contents:
|
||||||
|
|
||||||
.. toctree::
|
.. toctree::
|
||||||
:maxdepth: 1
|
:maxdepth: 2
|
||||||
|
|
||||||
transition
|
user/index
|
||||||
|
reference/index
|
||||||
Contributing
|
contributor/index
|
||||||
============
|
|
||||||
|
|
||||||
osc-lib utilizes all of the usual OpenStack processes and requirements for
|
|
||||||
contributions. The code is hosted `on OpenStack's Git server`_. `Bug reports`_
|
|
||||||
and `blueprints`_ may be submitted to the :code:`python-openstackclient` project
|
|
||||||
on `Launchpad`_. Code may be submitted to the
|
|
||||||
:code:`openstack/osc-lib` project using `Gerrit`_.
|
|
||||||
Developers may also be found in the `IRC channel`_ ``#openstack-sdks``.
|
|
||||||
|
|
||||||
.. _`on OpenStack's Git server`: https://git.openstack.org/cgit/openstack/python-openstackclient/tree
|
|
||||||
.. _Launchpad: https://launchpad.net/python-openstackclient
|
|
||||||
.. _Gerrit: http://docs.openstack.org/infra/manual/developers.html#development-workflow
|
|
||||||
.. _Bug reports: https://bugs.launchpad.net/python-openstackclient/+bugs
|
|
||||||
.. _blueprints: https://blueprints.launchpad.net/python-openstackclient
|
|
||||||
.. _PyPi: https://pypi.python.org/pypi/osc-lib
|
|
||||||
.. _tarball: http://tarballs.openstack.org/osc-lib
|
|
||||||
.. _IRC channel: https://wiki.openstack.org/wiki/IRC
|
|
||||||
|
|
||||||
Change Log
|
|
||||||
==========
|
|
||||||
|
|
||||||
.. toctree::
|
|
||||||
:maxdepth: 1
|
|
||||||
|
|
||||||
change_log
|
|
||||||
|
|
||||||
Indices and tables
|
Indices and tables
|
||||||
==================
|
==================
|
||||||
|
|
|
@ -0,0 +1,8 @@
|
||||||
|
=======================
|
||||||
|
Library API Reference
|
||||||
|
=======================
|
||||||
|
|
||||||
|
.. toctree::
|
||||||
|
:maxdepth: 2
|
||||||
|
|
||||||
|
api/autoindex
|
|
@ -0,0 +1 @@
|
||||||
|
.. include:: ../../../ChangeLog
|
|
@ -0,0 +1,9 @@
|
||||||
|
===============
|
||||||
|
Using osc-lib
|
||||||
|
===============
|
||||||
|
|
||||||
|
.. toctree::
|
||||||
|
:maxdepth: 2
|
||||||
|
|
||||||
|
transition
|
||||||
|
change_log
|
Loading…
Reference in New Issue