summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorDevananda van der Veen <devananda.vdv@gmail.com>2013-05-29 16:20:58 -0700
committerDevananda van der Veen <devananda.vdv@gmail.com>2013-05-29 16:20:58 -0700
commit676a157f421cd214524754f42263d99ec40c05f0 (patch)
tree01e86ed9507892174e294b2059e8d98a2c900e50 /doc
parent09271d52e5013da644447a8ca54a01f8897ee406 (diff)
downloadironic-676a157f421cd214524754f42263d99ec40c05f0.tar.gz
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
Diffstat (limited to 'doc')
-rw-r--r--doc/source/conf.py4
-rw-r--r--doc/source/dev/api-spec-v1.rst (renamed from doc/source/api-spec-v1.rst)0
-rw-r--r--doc/source/dev/api.rst11
-rw-r--r--doc/source/dev/architecture.rst (renamed from doc/source/architecture.rst)0
-rw-r--r--doc/source/dev/cmd.rst10
-rw-r--r--doc/source/dev/common.rst13
-rw-r--r--doc/source/dev/contributing.rst (renamed from doc/source/contributing.rst)0
-rw-r--r--doc/source/dev/db.rst13
-rw-r--r--doc/source/dev/dev-quickstart.rst (renamed from doc/source/dev-quickstart.rst)0
-rw-r--r--doc/source/dev/drivers.rst10
-rw-r--r--doc/source/dev/manager.rst10
-rw-r--r--doc/source/index.rst22
12 files changed, 81 insertions, 12 deletions
diff --git a/doc/source/conf.py b/doc/source/conf.py
index 73f4280f6..26c0c52ef 100644
--- a/doc/source/conf.py
+++ b/doc/source/conf.py
@@ -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.
diff --git a/doc/source/api-spec-v1.rst b/doc/source/dev/api-spec-v1.rst
index 1e5948c5b..1e5948c5b 100644
--- a/doc/source/api-spec-v1.rst
+++ b/doc/source/dev/api-spec-v1.rst
diff --git a/doc/source/dev/api.rst b/doc/source/dev/api.rst
new file mode 100644
index 000000000..26694a26b
--- /dev/null
+++ b/doc/source/dev/api.rst
@@ -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
diff --git a/doc/source/architecture.rst b/doc/source/dev/architecture.rst
index c8b1bf37d..c8b1bf37d 100644
--- a/doc/source/architecture.rst
+++ b/doc/source/dev/architecture.rst
diff --git a/doc/source/dev/cmd.rst b/doc/source/dev/cmd.rst
new file mode 100644
index 000000000..e8180e58f
--- /dev/null
+++ b/doc/source/dev/cmd.rst
@@ -0,0 +1,10 @@
+.. _cmd:
+
+==========================
+List of Installed Commands
+==========================
+
+.. toctree::
+ ../api/ironic.cmd.api
+ ../api/ironic.cmd.dbsync
+ ../api/ironic.cmd.manager
diff --git a/doc/source/dev/common.rst b/doc/source/dev/common.rst
new file mode 100644
index 000000000..afec82cfd
--- /dev/null
+++ b/doc/source/dev/common.rst
@@ -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
+
diff --git a/doc/source/contributing.rst b/doc/source/dev/contributing.rst
index 08a41251b..08a41251b 100644
--- a/doc/source/contributing.rst
+++ b/doc/source/dev/contributing.rst
diff --git a/doc/source/dev/db.rst b/doc/source/dev/db.rst
new file mode 100644
index 000000000..3235aff24
--- /dev/null
+++ b/doc/source/dev/db.rst
@@ -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
diff --git a/doc/source/dev-quickstart.rst b/doc/source/dev/dev-quickstart.rst
index 49363220f..49363220f 100644
--- a/doc/source/dev-quickstart.rst
+++ b/doc/source/dev/dev-quickstart.rst
diff --git a/doc/source/dev/drivers.rst b/doc/source/dev/drivers.rst
new file mode 100644
index 000000000..d89f76754
--- /dev/null
+++ b/doc/source/dev/drivers.rst
@@ -0,0 +1,10 @@
+.. _drivers:
+
+=================
+Pluggable Drivers
+=================
+
+.. toctree::
+ ../api/ironic.drivers.base
+ ../api/ironic.drivers.fake
+ ../api/ironic.drivers.ipmi
diff --git a/doc/source/dev/manager.rst b/doc/source/dev/manager.rst
new file mode 100644
index 000000000..d27047a04
--- /dev/null
+++ b/doc/source/dev/manager.rst
@@ -0,0 +1,10 @@
+.. _manager:
+
+==========================
+Ironic's Management Server
+==========================
+
+.. toctree::
+ ../api/ironic.manager.manager
+ ../api/ironic.manager.resource_manager
+ ../api/ironic.manager.task_manager
diff --git a/doc/source/index.rst b/doc/source/index.rst
index 9f0fa3f5a..a71bec200 100644
--- a/doc/source/index.rst
+++ b/doc/source/index.rst
@@ -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
==================