4acdad63ac
- The documentation index page will now contain a
Version 1 API Reference section with links to each v1 module and
documentation for each method in that module.
- Copied python-novaclients gen_ref method into the doc/source/conf.py file
that dyanamically generates the sphinx .rst files for each trove v1 module.
When it runs it will create generate a new folder named ref/v1/ and will
contain each module such as instances.rst with the filled out automodule
sphinx code.
Ex: /ref/v1/instances.rst
.. automodule:: troveclient.v1.instances
:members:
:undoc-members:
:show-inheritance:
Change-Id: Ib311486564f5b6def205590a1ccc2e493f3fef97
29 lines
777 B
ReStructuredText
29 lines
777 B
ReStructuredText
..
|
|
Licensed under the Apache License, Version 2.0 (the "License"); you may
|
|
not use this file except in compliance with the License. You may obtain
|
|
a copy of the License at
|
|
|
|
http://www.apache.org/licenses/LICENSE-2.0
|
|
|
|
Unless required by applicable law or agreed to in writing, software
|
|
distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
|
|
WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
|
|
License for the specific language governing permissions and limitations
|
|
under the License.
|
|
|
|
.. include:: ../../README.rst
|
|
:start-line: 0
|
|
:end-line: 22
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
|
|
usage
|
|
ref/v1/index
|
|
|
|
Indices and tables
|
|
==================
|
|
|
|
* :ref:`genindex`
|
|
* :ref:`search`
|