diff --git a/doc/source/conf.py b/doc/source/conf.py index 73f4280f63..26c0c52eff 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 similarity index 100% rename from doc/source/api-spec-v1.rst rename to 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 0000000000..26694a26b2 --- /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 similarity index 100% rename from doc/source/architecture.rst rename to doc/source/dev/architecture.rst diff --git a/doc/source/dev/cmd.rst b/doc/source/dev/cmd.rst new file mode 100644 index 0000000000..e8180e58f2 --- /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 0000000000..afec82cfdf --- /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 similarity index 100% rename from doc/source/contributing.rst rename to doc/source/dev/contributing.rst diff --git a/doc/source/dev/db.rst b/doc/source/dev/db.rst new file mode 100644 index 0000000000..3235aff243 --- /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 similarity index 100% rename from doc/source/dev-quickstart.rst rename to 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 0000000000..d89f76754f --- /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 0000000000..d27047a04b --- /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 9f0fa3f5a9..a71bec200d 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 ==================