diff options
-rw-r--r-- | docs/conf.py | 9 | ||||
-rw-r--r-- | docs/featureprojects.rst | 85 | ||||
-rw-r--r-- | docs/index.rst | 5 |
3 files changed, 46 insertions, 53 deletions
diff --git a/docs/conf.py b/docs/conf.py index bf24568a8..970e3fff0 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -288,7 +288,6 @@ intersphinx_mapping = {} intersphinx_mapping['apex'] = ('https://opnfv-apex.readthedocs.io/en/%s' % branch, None) intersphinx_mapping['armband'] = ('https://opnfv-armband.readthedocs.io/en/%s' % branch, None) intersphinx_mapping['auto'] = ('https://opnfv-auto.readthedocs.io/en/%s' % branch, None) -intersphinx_mapping['auto'] = ('https://opnfv-auto.readthedocs.io/en/%s' % branch, None) intersphinx_mapping['availability'] = ('https://opnfv-availability.readthedocs.io/en/%s' % branch, None) intersphinx_mapping['barometer'] = ('https://opnfv-barometer.readthedocs.io/en/%s' % branch, None) intersphinx_mapping['bottlenecks'] = ('https://opnfv-bottlenecks.readthedocs.io/en/%s' % branch, None) @@ -296,17 +295,17 @@ intersphinx_mapping['calipso'] = ('https://opnfv-calipso.readthedocs.io/en/%s' % intersphinx_mapping['clover'] = ('https://opnfv-clover.readthedocs.io/en/%s' % branch, None) intersphinx_mapping['compass4nfv'] = ('https://opnfv-compass4nfv.readthedocs.io/en/%s' % branch, None) intersphinx_mapping['container4nfv'] = ('https://opnfv-container4nfv.readthedocs.io/en/%s' % branch, None) -intersphinx_mapping['copper'] = ('https://opnfv-copper.readthedocs.io/en/%s' % branch, None) +# intersphinx_mapping['copper'] = ('https://opnfv-copper.readthedocs.io/en/%s' % branch, None) intersphinx_mapping['daisy'] = ('https://opnfv-daisy.readthedocs.io/en/%s' % branch, None) intersphinx_mapping['doctor'] = ('https://opnfv-doctor.readthedocs.io/en/%s' % branch, None) intersphinx_mapping['dovetail'] = ('https://opnfv-dovetail.readthedocs.io/en/%s' % branch, None) intersphinx_mapping['edgecloud'] = ('https://opnfv-edgecloud.readthedocs.io/en/%s' % branch, None) -intersphinx_mapping['fds'] = ('https://opnfv-fds.readthedocs.io/en/%s' % branch, None) +# intersphinx_mapping['fds'] = ('https://opnfv-fds.readthedocs.io/en/%s' % branch, None) intersphinx_mapping['fuel'] = ('https://opnfv-fuel.readthedocs.io/en/%s' % branch, None) intersphinx_mapping['functest'] = ('https://opnfv-functest.readthedocs.io/en/%s' % branch, None) intersphinx_mapping['ipv6'] = ('https://opnfv-ipv6.readthedocs.io/en/%s' % branch, None) -intersphinx_mapping['moon'] = ('https://opnfv-moon.readthedocs.io/en/%s' % branch, None) -intersphinx_mapping['netready'] = ('https://opnfv-netready.readthedocs.io/en/%s' % branch, None) +# intersphinx_mapping['moon'] = ('https://opnfv-moon.readthedocs.io/en/%s' % branch, None) +# intersphinx_mapping['netready'] = ('https://opnfv-netready.readthedocs.io/en/%s' % branch, None) intersphinx_mapping['nfvbench'] = ('https://opnfv-nfvbench.readthedocs.io/en/%s' % branch, None) intersphinx_mapping['onosfw'] = ('https://opnfv-onosfw.readthedocs.io/en/%s' % branch, None) intersphinx_mapping['orchestra'] = ('https://opnfv-orchestra.readthedocs.io/en/%s' % branch, None) diff --git a/docs/featureprojects.rst b/docs/featureprojects.rst index 9b3ad3989..447f81617 100644 --- a/docs/featureprojects.rst +++ b/docs/featureprojects.rst @@ -5,105 +5,102 @@ OPNFV Projects Apex ---- -.. toctree:: - :maxdepth: 1 * :doc:`Apex Overview <apex:index>` +* :doc:`Apex Installation instructions <apex:release/installation/index>` Armband ------- * :doc:`Armband Overview <armband:index>` +* :doc:`Armband Installation <armband:release/installation/index>` +* :doc:`Fuel User Guide <armband:release/userguide/index>` Availability ------------ -.. toctree:: - :maxdepth: 1 * :doc:`Availability overview <availability:index>` +* :doc:`High Availability Requirement Analysis in OPNFV <availability:development/overview/index>` Barometer --------- -.. toctree:: - :maxdepth: 1 -* :doc:`Barometer overview <barometer:index>` +* :doc:`Barometer Overview <barometer:index>` +* :doc:`Barometer Requirements <barometer:development/requirements/index>` +* :doc:`Barometer Config Guide <barometer:release/configguide/index>` +* :doc:`Barometer User Guide <barometer:release/userguide/index>` +* :doc:`Barometer Design Guide <barometer:development/design/index>` Clover ------ -.. toctree:: - :maxdepth: 1 -* :doc:`Clover overview <clover:index>` +* :doc:`Clover Overview <clover:index>` Compass4Nfv ----------- -.. toctree:: - :maxdepth: 1 -* :doc:`Compass4nfv overview <compass4nfv:index>` +* :doc:`Compass4nfv Overview <compass4nfv:index>` +* :doc:`Compass4nfv Installation <compass4nfv:release/installation/index>` +* :doc:`Compass4nfv Design Guide <compass4nfv:development/design/index>` Daisy4NFV --------- -.. toctree:: - :maxdepth: 1 * :doc:`Daisy overview <daisy:index>` +* :doc:`Daisy Design Guide <daisy:development/design/index>` +* :doc:`Daisy Config Guide <daisy:release/configguide/index>` +* :doc:`Daisy Installation Guide <daisy:release/installation/index>` Doctor ------ -.. toctree:: - :maxdepth: 1 * :doc:`Doctor overview <doctor:index>` +* :doc:`Doctor Requirements <doctor:development/requirements/index>` +* :doc:`Doctor Config Guide <doctor:release/configguide/index>` +* :doc:`Doctor User Guide <doctor:release/userguide/index>` +* :doc:`Doctor Design Guide <doctor:development/design/index>` +* :doc:`OpenStack NOVA API for marking host down <doctor:development/manuals/index>` Edgecloud --------- -.. toctree:: - :maxdepth: 1 -* :doc:`Edgecloud overview <edgecloud:index>` +* :doc:`Edgecloud Overview <edgecloud:index>` +* :doc:`Edgecloud Requirements <edgecloud:development/requirements/index>` IPV6 ---- -.. toctree:: - :maxdepth: 1 -* :doc:`IPV6 overview <ipv6:index>` +* :doc:`IPV6 Overview <ipv6:index>` +* :doc:`IPV6 Installation Guide <ipv6:release/installation/index>` +* :doc:`IPV6 Config Guide <ipv6:release/configguide/index>` +* :doc:`IPV6 User Guide <ipv6:release/userguide/index>` -Joid ----- -.. toctree:: - :maxdepth: 1 - -* :doc:`JOID overview <joid:index>` - -Opera ------ -.. toctree:: - :maxdepth: 1 - -* :doc:`Opera overview <opera:index>` Parser ------ -.. toctree:: - :maxdepth: 1 * :doc:`Parser overview <parser:index>` +* :doc:`Parser Installation Guide <parser:release/installation/index>` +* :doc:`Parser Config Guide <parser:release/configguide/index>` +* :doc:`Parser User Guide <parser:release/userguide/index>` SDNVPN -------- -.. toctree:: - :maxdepth: 1 -* :doc:`Sdnvpn overview <sdnvpn:index>` +* :doc:`Sdnvpn Overview <sdnvpn:index>` +* :doc:`Sdnvpn Requirements <sdnvpn:development/requirements/index>` +* :doc:`Sdnvpn Installation Guide <sdnvpn:release/installation/index>` +* :doc:`Sdnvpn Config Guide <sdnvpn:release/configguide/index>` +* :doc:`Sdnvpn User Guide <sdnvpn:release/userguide/index>` +* :doc:`Sdnvpn Feature and API usage guidelines <sdnvpn:development/design/index>` SFC --- -.. toctree:: - :maxdepth: 1 -* :doc:`SFC overview <sfc:index>` +* :doc:`SFC Overview <sfc:index>` +* :doc:`SFC Requirements <sfc:development/requirements/index>` +* :doc:`SFC Config Guide <sfc:release/configguide/index>` +* :doc:`SFC User Guide <sfc:release/userguide/index>` +* :doc:`SFC Devlopment Guide <sfc:development/design/index>` diff --git a/docs/index.rst b/docs/index.rst index 8b683e5fb..2d949dab6 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -54,10 +54,7 @@ Infrastructure Operations Supporting Tools --------------------------- -.. toctree:: - :maxdepth: 1 - - :ref:`<calipso-release-guide>` +* :ref:`Calipso <calipso-release-guide>` Found a typo or any other feedback? Send an email to users@opnfv.org or talk to us on IRC_. |