doc migration
- fix sphinx errors - enable warning-is-error - reorganize structure - use openstackdocstheme Change-Id: I87df64b3a57e03618072a53bbe66bd3e83ac4e72
This commit is contained in:
parent
91b58c72c1
commit
2ad2a87fa8
|
@ -18,7 +18,9 @@ from keystoneauth1 import adapter
|
||||||
class Client(object):
|
class Client(object):
|
||||||
"""Client for the Congress v1 API.
|
"""Client for the Congress v1 API.
|
||||||
|
|
||||||
Example::
|
Example
|
||||||
|
::
|
||||||
|
|
||||||
from keystoneauth1.identity import v2
|
from keystoneauth1.identity import v2
|
||||||
from keystoneauth1 import session
|
from keystoneauth1 import session
|
||||||
from congressclient.v1 import client
|
from congressclient.v1 import client
|
||||||
|
|
|
@ -1,4 +1,4 @@
|
||||||
============
|
============
|
||||||
Contributing
|
Contributing
|
||||||
============
|
============
|
||||||
.. include:: ../../CONTRIBUTING.rst
|
.. include:: ../../../CONTRIBUTING.rst
|
|
@ -9,16 +9,21 @@ Welcome to python-congressclient's documentation!
|
||||||
Contents:
|
Contents:
|
||||||
|
|
||||||
.. toctree::
|
.. toctree::
|
||||||
:maxdepth: 2
|
:maxdepth: 1
|
||||||
|
|
||||||
readme
|
user/readme
|
||||||
installation
|
install/index
|
||||||
usage
|
user/index
|
||||||
contributing
|
contributor/index
|
||||||
|
reference/index
|
||||||
Indices and tables
|
|
||||||
==================
|
|
||||||
|
|
||||||
* :ref:`genindex`
|
* :ref:`genindex`
|
||||||
* :ref:`modindex`
|
|
||||||
* :ref:`search`
|
* :ref:`search`
|
||||||
|
|
||||||
|
.. # Below are items we don't want to show doc consumers but need to be
|
||||||
|
# included to avoid sphinx warning/error.
|
||||||
|
# api/autoindex hidden because the information is already in modindex above
|
||||||
|
.. toctree::
|
||||||
|
:hidden:
|
||||||
|
|
||||||
|
reference/api/autoindex
|
|
@ -1 +0,0 @@
|
||||||
.. include:: ../../README.rst
|
|
|
@ -0,0 +1,5 @@
|
||||||
|
==========
|
||||||
|
References
|
||||||
|
==========
|
||||||
|
|
||||||
|
* :ref:`modindex`
|
|
@ -1,6 +1,6 @@
|
||||||
========
|
=====
|
||||||
Usage
|
Usage
|
||||||
========
|
=====
|
||||||
|
|
||||||
To use python-congressclient in a project::
|
To use python-congressclient in a project::
|
||||||
|
|
|
@ -0,0 +1,5 @@
|
||||||
|
##########
|
||||||
|
README
|
||||||
|
##########
|
||||||
|
|
||||||
|
.. include:: ../../../README.rst
|
|
@ -58,12 +58,14 @@ openstack.congressclient.v1 =
|
||||||
|
|
||||||
[pbr]
|
[pbr]
|
||||||
autodoc_index_modules = True
|
autodoc_index_modules = True
|
||||||
|
api_doc_dir = reference/api
|
||||||
warnerrors = True
|
warnerrors = True
|
||||||
|
|
||||||
[build_sphinx]
|
[build_sphinx]
|
||||||
source-dir = doc/source
|
source-dir = doc/source
|
||||||
build-dir = doc/build
|
build-dir = doc/build
|
||||||
all_files = 1
|
all_files = 1
|
||||||
|
warning-is-error = 1
|
||||||
|
|
||||||
[upload_sphinx]
|
[upload_sphinx]
|
||||||
upload-dir = doc/build/html
|
upload-dir = doc/build/html
|
||||||
|
|
Loading…
Reference in New Issue