diff --git a/doc/source/devref/index.rst b/doc/source/devref/index.rst new file mode 100644 index 000000000..10d99ceb5 --- /dev/null +++ b/doc/source/devref/index.rst @@ -0,0 +1,75 @@ +.. + Copyright 2015 OpenStack Foundation + All Rights Reserved. + + Licensed under the Apache License, Version 2.0 (the "License"); you may + not use this file except in compliance with the License. You may obtain + a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, WITHOUT + WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the + License for the specific language governing permissions and limitations + under the License. + +Developer Guide +=============== + +In the Developer Guide, you will find information on the design, and +architecture of the Neutron Virtual Private Network as a Service repo. +This include things like, information on the reference implementation +flavors, design details on VPNaaS internals, and testing. Developers +will extend this, as needed, in the future to contain more information. + + +VPNaaS Flavors +----------------- +.. toctree:: + :maxdepth: 3 + +.. todo:: + + Info on the different Swan flavors, how they are different, and what + Operating Systems support them. + + +VPNaaS Internals +----------------- +.. toctree:: + :maxdepth: 3 + +.. todo:: + + Add design details about VPN, especially items that are not obvious. + Can indication restrictions/limitations. + + +Testing +------- +.. toctree:: + :maxdepth: 3 + +.. todo:: + + Add notes about functional testing, with info on how + different reference drivers are tested. + + +Module Reference +---------------- +.. toctree:: + :maxdepth: 3 + +.. todo:: + + Add in all the big modules as automodule indexes. + + +Indices and tables +------------------ + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` diff --git a/doc/source/index.rst b/doc/source/index.rst index f7c2916d5..aeced4d3b 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -1,17 +1,50 @@ -.. documentation master file +.. + Copyright 2015 OpenStack Foundation + All Rights Reserved. -==== -Main -==== + Licensed under the Apache License, Version 2.0 (the "License"); you may + not use this file except in compliance with the License. You may obtain + a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, WITHOUT + WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the + License for the specific language governing permissions and limitations + under the License. + +Welcome to Neutron VPNaaS developer documentation! +================================================== + +This provides Virtual Private Network as a Service (VPNaaS) capabilities to Neutron. +Maintained as a separate repo, this works in conjunction with the Neutron repo to +provide VPN services for OpenStack. The `VPNaaS API`_ is implementation as an +extension to Neutron's networking API: + +.. _`VPNaaS API`: http://developer.openstack.org/api-ref-networking-v2-ext.html#vpnaas-v2.0 + +This documentation is generated by the Sphinx toolkit and lives in the source +tree. Additional documentation on VPNaaS and other components of OpenStack +can be found on the `OpenStack wiki`_ and the `Neutron section of the wiki`_ (see +the VPN related pages). +The `Neutron Development wiki`_ is also a good resource for new contributors. + +.. _`OpenStack wiki`: http://wiki.openstack.org +.. _`Neutron section of the wiki`: http://wiki.openstack.org/Neutron +.. _`Neutron Development wiki`: http://wiki.openstack.org/NeutronDevelopment + +Enjoy! + +Developer Docs +============== .. toctree:: - :glob: :maxdepth: 1 - main/* + devref/index -================== -Indices and tables -================== +API Extensions +============== -* :ref:`search` +Go to http://api.openstack.org for information about OpenStack Network API extensions. diff --git a/tox.ini b/tox.ini index fe629abbd..79f8277ee 100644 --- a/tox.ini +++ b/tox.ini @@ -90,7 +90,7 @@ commands = commands = {posargs} [testenv:docs] -commands = python setup.py build_sphinx +commands = sphinx-build -W -b html doc/source doc/build [flake8] # E125 continuation line does not distinguish itself from next logical line