More doc updates.
Create doc/source/dev/ directory, and add several files that got accidentaly ignored because they were under doc/source/api/. Also move some files from doc/source into doc/source/dev to clean up the base doc dir. Change-Id: Ief9777216db82ec3be32b7a73e2d268a3a973ef8
This commit is contained in:
parent
09271d52e5
commit
676a157f42
@ -6,7 +6,9 @@
|
||||
# Add any Sphinx extension module names here, as strings. They can be
|
||||
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
|
||||
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
|
||||
# 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.
|
||||
|
||||
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!
|
||||
@ -47,9 +47,9 @@ functionality, the following documentation is provided.
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
architecture
|
||||
contributing
|
||||
dev-quickstart
|
||||
dev/architecture
|
||||
dev/contributing
|
||||
dev/dev-quickstart
|
||||
|
||||
Client API Reference
|
||||
--------------------
|
||||
@ -57,7 +57,7 @@ Client API Reference
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
api-spec-v1
|
||||
dev/api-spec-v1
|
||||
|
||||
Python API Quick Reference
|
||||
--------------------------
|
||||
@ -65,12 +65,12 @@ Python API Quick Reference
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
api/api
|
||||
api/cmd
|
||||
api/common
|
||||
api/db
|
||||
api/drivers
|
||||
api/manager
|
||||
dev/api
|
||||
dev/cmd
|
||||
dev/common
|
||||
dev/db
|
||||
dev/drivers
|
||||
dev/manager
|
||||
|
||||
Indices and tables
|
||||
==================
|
||||
|
Loading…
Reference in New Issue
Block a user