diff --git a/.gitignore b/.gitignore index 2cb11fe9d..e0216e106 100644 --- a/.gitignore +++ b/.gitignore @@ -6,7 +6,7 @@ cover/ covhtml/ dist/ doc/build -doc/source/api/ +doc/source/contributor/api/ etc/*.sample *.DS_Store *.pyc diff --git a/devstack/README.rst b/devstack/README.rst index 69c31ca1a..f41839e40 100644 --- a/devstack/README.rst +++ b/devstack/README.rst @@ -1,3 +1,4 @@ +========================= neutron-fwaas in DevStack ========================= diff --git a/doc/source/contributing.rst b/doc/source/contributor/contributing.rst similarity index 70% rename from doc/source/contributing.rst rename to doc/source/contributor/contributing.rst index c9bc65aac..a163a5e62 100644 --- a/doc/source/contributing.rst +++ b/doc/source/contributor/contributing.rst @@ -1,26 +1,22 @@ +============================= Contributing to neutron-fwaas ============================= If you would like to contribute to the development of OpenStack, you must follow the steps documented at: - - https://docs.openstack.org/infra/manual/developers.html +https://docs.openstack.org/infra/manual/developers.html Once those steps have been completed, changes to OpenStack should be submitted for review via the Gerrit tool, following the workflow documented at: - - https://docs.openstack.org/infra/manual/developers.html#development-workflow +https://docs.openstack.org/infra/manual/developers.html#development-workflow Pull requests submitted through GitHub will be ignored. Bugs should be filed on Launchpad in the 'neutron' project: +https://bugs.launchpad.net/neutron - https://bugs.launchpad.net/neutron - -Getting in touch with the neutron-fwaas community -================================================= - -To contribute to the neutron-fwaas project, look at the following resources: +To get in touch with the neutron-fwaas community, +look at the following resources: - Join the #openstack-fwaas IRC channel on Freenode. This is where the FireWall-as-a-Service team is available for discussion. @@ -30,4 +26,3 @@ To contribute to the neutron-fwaas project, look at the following resources: These are a great places to get recommendations on where to start contributing to neutron-fwaas. - diff --git a/doc/source/contributor/devstack.rst b/doc/source/contributor/devstack.rst new file mode 100644 index 000000000..da85f63d0 --- /dev/null +++ b/doc/source/contributor/devstack.rst @@ -0,0 +1 @@ +.. include:: ../../../devstack/README.rst diff --git a/doc/source/fwaas_v2.rst b/doc/source/contributor/fwaas_v2.rst similarity index 100% rename from doc/source/fwaas_v2.rst rename to doc/source/contributor/fwaas_v2.rst diff --git a/doc/source/contributor/index.rst b/doc/source/contributor/index.rst new file mode 100644 index 000000000..ca3f7d137 --- /dev/null +++ b/doc/source/contributor/index.rst @@ -0,0 +1,17 @@ +================= +Contributor Guide +================= + +.. toctree:: + :maxdepth: 2 + + contributing + fwaas_v2 + devstack + +.. API reference contains a lot of sections, toctree with maxdepth 1 is used. +.. toctree:: + :glob: + :maxdepth: 1 + + modules diff --git a/doc/source/contributor/modules.rst b/doc/source/contributor/modules.rst new file mode 100644 index 000000000..e5f5513f6 --- /dev/null +++ b/doc/source/contributor/modules.rst @@ -0,0 +1,9 @@ +================ +Module Reference +================ + +.. toctree:: + :maxdepth: 1 + :glob: + + api/* diff --git a/doc/source/devstack.rst b/doc/source/devstack.rst deleted file mode 100644 index 4b1dfbf3e..000000000 --- a/doc/source/devstack.rst +++ /dev/null @@ -1 +0,0 @@ -.. include:: ../../devstack/README.rst diff --git a/doc/source/index.rst b/doc/source/index.rst index e9d552234..19fa0755a 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -1,27 +1,15 @@ -.. documentation master file - - -Developer documentation for neutron-fwaas -========================================= +=========================== +neutron-fwaas documentation +=========================== General Information and Other Project References: .. toctree:: :glob: - :maxdepth: 1 + :maxdepth: 2 - installation - fwaas_v2 - contributing - -Testing and Usage Information: - -.. toctree:: - :glob: - :maxdepth: 1 - - devstack - API reference + install/index + contributor/index .. rubric:: Indices and tables diff --git a/doc/source/installation.rst b/doc/source/install/index.rst similarity index 100% rename from doc/source/installation.rst rename to doc/source/install/index.rst diff --git a/setup.cfg b/setup.cfg index ce32f6271..d23f23354 100644 --- a/setup.cfg +++ b/setup.cfg @@ -83,3 +83,4 @@ autodoc_tree_index_modules = True autodoc_tree_excludes = setup.py neutron_fwaas/tests +api_doc_dir = contributor/api