Merge "More doc updates."
This commit is contained in:
commit
dff6b2d359
@ -6,7 +6,9 @@
|
|||||||
# Add any Sphinx extension module names here, as strings. They can be
|
# Add any Sphinx extension module names here, as strings. They can be
|
||||||
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
|
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
|
||||||
extensions = ['sphinx.ext.autodoc',
|
extensions = ['sphinx.ext.autodoc',
|
||||||
'sphinx.ext.intersphinx']
|
'sphinx.ext.intersphinx',
|
||||||
|
'sphinx.ext.viewcode',
|
||||||
|
]
|
||||||
|
|
||||||
# autodoc generation is a bit aggressive and a nuisance when doing heavy
|
# autodoc generation is a bit aggressive and a nuisance when doing heavy
|
||||||
# text edit cycles.
|
# text edit cycles.
|
||||||
|
11
doc/source/dev/api.rst
Normal file
11
doc/source/dev/api.rst
Normal file
@ -0,0 +1,11 @@
|
|||||||
|
.. _api:
|
||||||
|
|
||||||
|
===========
|
||||||
|
Ironic's API Server
|
||||||
|
===========
|
||||||
|
|
||||||
|
.. toctree::
|
||||||
|
../api/ironic.api.config
|
||||||
|
../api/ironic.api.controllers.root
|
||||||
|
../api/ironic.api.controllers.v1
|
||||||
|
../api/ironic.api.hooks
|
10
doc/source/dev/cmd.rst
Normal file
10
doc/source/dev/cmd.rst
Normal file
@ -0,0 +1,10 @@
|
|||||||
|
.. _cmd:
|
||||||
|
|
||||||
|
==========================
|
||||||
|
List of Installed Commands
|
||||||
|
==========================
|
||||||
|
|
||||||
|
.. toctree::
|
||||||
|
../api/ironic.cmd.api
|
||||||
|
../api/ironic.cmd.dbsync
|
||||||
|
../api/ironic.cmd.manager
|
13
doc/source/dev/common.rst
Normal file
13
doc/source/dev/common.rst
Normal file
@ -0,0 +1,13 @@
|
|||||||
|
.. _common:
|
||||||
|
|
||||||
|
============================
|
||||||
|
Common Modules and Utilities
|
||||||
|
============================
|
||||||
|
|
||||||
|
.. toctree::
|
||||||
|
../api/ironic.common.context
|
||||||
|
../api/ironic.common.exception
|
||||||
|
../api/ironic.common.service
|
||||||
|
../api/ironic.common.states
|
||||||
|
../api/ironic.common.utils
|
||||||
|
|
13
doc/source/dev/db.rst
Normal file
13
doc/source/dev/db.rst
Normal file
@ -0,0 +1,13 @@
|
|||||||
|
.. _db:
|
||||||
|
|
||||||
|
============
|
||||||
|
DB API Layer
|
||||||
|
============
|
||||||
|
|
||||||
|
.. toctree::
|
||||||
|
../api/ironic.db.api
|
||||||
|
../api/ironic.db.migration
|
||||||
|
../api/ironic.db.models
|
||||||
|
../api/ironic.db.sqlalchemy.api
|
||||||
|
../api/ironic.db.sqlalchemy.migration
|
||||||
|
../api/ironic.db.sqlalchemy.models
|
10
doc/source/dev/drivers.rst
Normal file
10
doc/source/dev/drivers.rst
Normal file
@ -0,0 +1,10 @@
|
|||||||
|
.. _drivers:
|
||||||
|
|
||||||
|
=================
|
||||||
|
Pluggable Drivers
|
||||||
|
=================
|
||||||
|
|
||||||
|
.. toctree::
|
||||||
|
../api/ironic.drivers.base
|
||||||
|
../api/ironic.drivers.fake
|
||||||
|
../api/ironic.drivers.ipmi
|
10
doc/source/dev/manager.rst
Normal file
10
doc/source/dev/manager.rst
Normal file
@ -0,0 +1,10 @@
|
|||||||
|
.. _manager:
|
||||||
|
|
||||||
|
==========================
|
||||||
|
Ironic's Management Server
|
||||||
|
==========================
|
||||||
|
|
||||||
|
.. toctree::
|
||||||
|
../api/ironic.manager.manager
|
||||||
|
../api/ironic.manager.resource_manager
|
||||||
|
../api/ironic.manager.task_manager
|
@ -17,7 +17,7 @@ together multiple drivers, each of which implement some portion of that
|
|||||||
functionality with respect to physical hardware.
|
functionality with respect to physical hardware.
|
||||||
|
|
||||||
For an in-depth look at the project's scope and structure, see the
|
For an in-depth look at the project's scope and structure, see the
|
||||||
:doc:`architecture` page.
|
:doc:`dev/architecture` page.
|
||||||
|
|
||||||
|
|
||||||
Status: Hard Hat Required!
|
Status: Hard Hat Required!
|
||||||
@ -47,9 +47,9 @@ functionality, the following documentation is provided.
|
|||||||
.. toctree::
|
.. toctree::
|
||||||
:maxdepth: 1
|
:maxdepth: 1
|
||||||
|
|
||||||
architecture
|
dev/architecture
|
||||||
contributing
|
dev/contributing
|
||||||
dev-quickstart
|
dev/dev-quickstart
|
||||||
|
|
||||||
Client API Reference
|
Client API Reference
|
||||||
--------------------
|
--------------------
|
||||||
@ -57,7 +57,7 @@ Client API Reference
|
|||||||
.. toctree::
|
.. toctree::
|
||||||
:maxdepth: 1
|
:maxdepth: 1
|
||||||
|
|
||||||
api-spec-v1
|
dev/api-spec-v1
|
||||||
|
|
||||||
Python API Quick Reference
|
Python API Quick Reference
|
||||||
--------------------------
|
--------------------------
|
||||||
@ -65,12 +65,12 @@ Python API Quick Reference
|
|||||||
.. toctree::
|
.. toctree::
|
||||||
:maxdepth: 2
|
:maxdepth: 2
|
||||||
|
|
||||||
api/api
|
dev/api
|
||||||
api/cmd
|
dev/cmd
|
||||||
api/common
|
dev/common
|
||||||
api/db
|
dev/db
|
||||||
api/drivers
|
dev/drivers
|
||||||
api/manager
|
dev/manager
|
||||||
|
|
||||||
Indices and tables
|
Indices and tables
|
||||||
==================
|
==================
|
||||||
|
Loading…
x
Reference in New Issue
Block a user