tobiko/doc/source/reference/index.rst
Slawek Kaplonski 9a6c62f479 Make sphinx to generate Tobiko API docs based on docstrings
This requires fixing a number of docstring so they are valid rST. We add
the '--keep-going' flag to our Sphinx calls so we don't stop on the very
first failure.

Change-Id: Ia195fbc3be2e840e2afe1429b2bc2654bd1d5385
Co-authored-by: Stephen Finucane <stephenfin@redhat.com>
2023-03-31 18:38:30 +02:00

45 lines
1.2 KiB
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.
Convention for heading levels in Neutron lib devref:
======= Heading 0 (reserved for the title in a document)
------- Heading 1
~~~~~~~ Heading 2
+++++++ Heading 3
''''''' Heading 4
(Avoid deeper levels because they do not render well.)
================================
Tobiko Framework Reference Guide
================================
Tobiko package
--------------
.. toctree::
:maxdepth: 4
modules/tobiko
modules/actors
modules/docker
modules/http
modules/openstack/index
modules/podman
modules/run
modules/shell/index
modules/shiftstack
modules/tripleo/index
* :ref:`genindex`
* :ref:`search`