diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/conf.py | 5 | ||||
| -rw-r--r-- | docs/featureprojects.rst | 463 | ||||
| -rw-r--r-- | docs/release/release-notes.rst | 4 | ||||
| -rw-r--r-- | docs/release/userguide.introduction.rst | 4 | ||||
| -rw-r--r-- | docs/testing/testing-dev.rst | 8 | ||||
| -rw-r--r-- | docs/testing/testing-user.rst | 18 |
6 files changed, 414 insertions, 88 deletions
diff --git a/docs/conf.py b/docs/conf.py index 5cf18ddf3..a5e9fd235 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -1,4 +1,5 @@ import sphinx_bootstrap_theme +import os # If extensions (or modules to document with autodoc) are in another directory, # add these directories to sys.path here. If the directory is relative to the @@ -40,9 +41,9 @@ author = 'Open Platform for NFV' # built documents. # # The short X.Y version. -version = 'Danube' +version = 'Latest' # The full version, including alpha/beta/rc tags. -release = 'Danube' +release = 'Latest' # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. diff --git a/docs/featureprojects.rst b/docs/featureprojects.rst index 6f45f0805..a9ec17d50 100644 --- a/docs/featureprojects.rst +++ b/docs/featureprojects.rst @@ -1,210 +1,521 @@ OPNFV Projects ================ -ARMband --------- +Apex +---- .. toctree:: :maxdepth: 1 - ../submodules/armband/docs/release/configguide/index + ../submodules/apex/docs/development/overview/index + ../submodules/apex/docs/development/requirements/index + ../submodules/apex/docs/release/installation/index + ../submodules/apex/docs/release/configguide/index + ../submodules/apex/docs/release/userguide/index + ../submodules/apex/docs/development/design/index + ../submodules/apex/docs/development/manuals/index + + +Armband +------- +.. toctree:: + :maxdepth: 1 + + ../submodules/armband/docs/development/overview/index + ../submodules/armband/docs/development/requirements/index ../submodules/armband/docs/release/installation/index + ../submodules/armband/docs/release/configguide/index ../submodules/armband/docs/release/userguide/index ../submodules/armband/docs/development/design/index ../submodules/armband/docs/development/manuals/index - ../submodules/armband/docs/development/overview/index - ../submodules/armband/docs/development/requirements/index + + +Availability +------------ +.. toctree:: + :maxdepth: 1 + + ../submodules/availability/docs/development/overview/index + ../submodules/availability/docs/development/requirements/index + ../submodules/availability/docs/release/installation/index + ../submodules/availability/docs/release/configguide/index + ../submodules/availability/docs/release/userguide/index + ../submodules/availability/docs/development/design/index + ../submodules/availability/docs/development/manuals/index Barometer ----------- +--------- .. toctree:: :maxdepth: 1 - ../submodules/barometer/docs/release/configguide/index + ../submodules/barometer/docs/development/overview/index + ../submodules/barometer/docs/development/requirements/index ../submodules/barometer/docs/release/installation/index + ../submodules/barometer/docs/release/configguide/index ../submodules/barometer/docs/release/userguide/index ../submodules/barometer/docs/development/design/index ../submodules/barometer/docs/development/manuals/index - ../submodules/barometer/docs/development/overview/index - ../submodules/barometer/docs/development/requirements/index + + +Bottlenecks +----------- +.. toctree:: + :maxdepth: 1 + + ../submodules/bottlenecks/docs/development/overview/index + ../submodules/bottlenecks/docs/development/requirements/index + ../submodules/bottlenecks/docs/release/installation/index + ../submodules/bottlenecks/docs/release/configguide/index + ../submodules/bottlenecks/docs/release/userguide/index + ../submodules/bottlenecks/docs/development/design/index + ../submodules/bottlenecks/docs/development/manuals/index + + +Compass4Nfv +----------- +.. toctree:: + :maxdepth: 1 + + ../submodules/compass4nfv/docs/development/overview/index + ../submodules/compass4nfv/docs/development/requirements/index + ../submodules/compass4nfv/docs/release/installation/index + ../submodules/compass4nfv/docs/release/configguide/index + ../submodules/compass4nfv/docs/release/userguide/index + ../submodules/compass4nfv/docs/development/design/index + ../submodules/compass4nfv/docs/development/manuals/index Copper --------- +------ .. toctree:: :maxdepth: 1 - ../submodules/copper/docs/release/configguide/index + ../submodules/copper/docs/development/overview/index + ../submodules/copper/docs/development/requirements/index ../submodules/copper/docs/release/installation/index + ../submodules/copper/docs/release/configguide/index ../submodules/copper/docs/release/userguide/index ../submodules/copper/docs/development/design/index ../submodules/copper/docs/development/manuals/index - ../submodules/copper/docs/development/overview/index - ../submodules/copper/docs/development/requirements/index + + +Daisy +----- +.. toctree:: + :maxdepth: 1 + + ../submodules/daisy/docs/development/overview/index + ../submodules/daisy/docs/development/requirements/index + ../submodules/daisy/docs/release/installation/index + ../submodules/daisy/docs/release/configguide/index + ../submodules/daisy/docs/release/userguide/index + ../submodules/daisy/docs/development/design/index + ../submodules/daisy/docs/development/manuals/index Doctor --------- +------ .. toctree:: :maxdepth: 1 - ../submodules/doctor/docs/release/configguide/index + ../submodules/doctor/docs/development/overview/index + ../submodules/doctor/docs/development/requirements/index ../submodules/doctor/docs/release/installation/index + ../submodules/doctor/docs/release/configguide/index ../submodules/doctor/docs/release/userguide/index ../submodules/doctor/docs/development/design/index ../submodules/doctor/docs/development/manuals/index - ../submodules/doctor/docs/development/overview/index - ../submodules/doctor/docs/development/requirements/index + Domino --------- +------ .. toctree:: :maxdepth: 1 - ../submodules/domino/docs/release/configguide/index + ../submodules/domino/docs/development/overview/index + ../submodules/domino/docs/development/requirements/index ../submodules/domino/docs/release/installation/index + ../submodules/domino/docs/release/configguide/index ../submodules/domino/docs/release/userguide/index ../submodules/domino/docs/development/design/index ../submodules/domino/docs/development/manuals/index - ../submodules/domino/docs/development/overview/index - ../submodules/domino/docs/development/requirements/index -IPV6 +Escalator +--------- +.. toctree:: + :maxdepth: 1 + + ../submodules/escalator/docs/development/overview/index + ../submodules/escalator/docs/development/requirements/index + ../submodules/escalator/docs/release/installation/index + ../submodules/escalator/docs/release/configguide/index + ../submodules/escalator/docs/release/userguide/index + ../submodules/escalator/docs/development/design/index + ../submodules/escalator/docs/development/manuals/index + + +Fastpathmetrics +--------------- +.. toctree:: + :maxdepth: 1 + + ../submodules/fastpathmetrics/docs/development/overview/index + ../submodules/fastpathmetrics/docs/development/requirements/index + ../submodules/fastpathmetrics/docs/release/installation/index + ../submodules/fastpathmetrics/docs/release/configguide/index + ../submodules/fastpathmetrics/docs/release/userguide/index + ../submodules/fastpathmetrics/docs/development/design/index + ../submodules/fastpathmetrics/docs/development/manuals/index + + +Fds +--- +.. toctree:: + :maxdepth: 1 + + ../submodules/fds/docs/development/overview/index + ../submodules/fds/docs/development/requirements/index + ../submodules/fds/docs/release/installation/index + ../submodules/fds/docs/release/configguide/index + ../submodules/fds/docs/release/userguide/index + ../submodules/fds/docs/development/design/index + ../submodules/fds/docs/development/manuals/index + + +Fuel +---- +.. toctree:: + :maxdepth: 1 + + ../submodules/fuel/docs/development/overview/index + ../submodules/fuel/docs/development/requirements/index + ../submodules/fuel/docs/release/installation/index + ../submodules/fuel/docs/release/configguide/index + ../submodules/fuel/docs/release/userguide/index + ../submodules/fuel/docs/development/design/index + ../submodules/fuel/docs/development/manuals/index + + +Functest -------- .. toctree:: :maxdepth: 1 - ../submodules/ipv6/docs/release/configguide/index + ../submodules/functest/docs/development/overview/index + ../submodules/functest/docs/development/requirements/index + ../submodules/functest/docs/release/installation/index + ../submodules/functest/docs/release/configguide/index + ../submodules/functest/docs/release/userguide/index + ../submodules/functest/docs/development/design/index + ../submodules/functest/docs/development/manuals/index + + +IPV6 +---- +.. toctree:: + :maxdepth: 1 + + ../submodules/ipv6/docs/development/overview/index + ../submodules/ipv6/docs/development/requirements/index ../submodules/ipv6/docs/release/installation/index + ../submodules/ipv6/docs/release/configguide/index ../submodules/ipv6/docs/release/userguide/index ../submodules/ipv6/docs/development/design/index ../submodules/ipv6/docs/development/manuals/index - ../submodules/ipv6/docs/development/overview/index - ../submodules/ipv6/docs/development/requirements/index -KVM for NFV -------------- +Joid +---- .. toctree:: :maxdepth: 1 - ../submodules/kvmfornfv/docs/release/configguide/index - ../submodules/kvmfornfv/docs/release/installation/index - ../submodules/kvmfornfv/docs/release/userguide/index - ../submodules/kvmfornfv/docs/development/design/index - ../submodules/kvmfornfv/docs/development/manuals/index - ../submodules/kvmfornfv/docs/development/overview/index - ../submodules/kvmfornfv/docs/development/requirements/index + ../submodules/joid/docs/development/overview/index + ../submodules/joid/docs/development/requirements/index + ../submodules/joid/docs/release/installation/index + ../submodules/joid/docs/release/configguide/index + ../submodules/joid/docs/release/userguide/index + ../submodules/joid/docs/development/design/index + ../submodules/joid/docs/development/manuals/index -Moon ------- +Kvmfornfv +--------- .. toctree:: :maxdepth: 1 - ../submodules/moon/docs/release/configguide/index - ../submodules/moon/docs/release/installation/index - ../submodules/moon/docs/release/userguide/index - ../submodules/moon/docs/development/design/index - ../submodules/moon/docs/development/manuals/index - ../submodules/moon/docs/development/overview/index - ../submodules/moon/docs/development/requirements/index + ../submodules/kvmfornfv/docs/development/overview/index + ../submodules/kvmfornfv/docs/development/requirements/index + ../submodules/kvmfornfv/docs/release/installation/index + ../submodules/kvmfornfv/docs/release/configguide/index + ../submodules/kvmfornfv/docs/release/userguide/index + ../submodules/kvmfornfv/docs/development/design/index + ../submodules/kvmfornfv/docs/development/manuals/index Multisite ----------- +--------- .. toctree:: :maxdepth: 1 - ../submodules/multisite/docs/release/configguide/index + ../submodules/multisite/docs/development/overview/index + ../submodules/multisite/docs/development/requirements/index ../submodules/multisite/docs/release/installation/index + ../submodules/multisite/docs/release/configguide/index ../submodules/multisite/docs/release/userguide/index ../submodules/multisite/docs/development/design/index ../submodules/multisite/docs/development/manuals/index - ../submodules/multisite/docs/development/overview/index - ../submodules/multisite/docs/development/requirements/index Netready ---------- +-------- .. toctree:: :maxdepth: 1 - ../submodules/netready/docs/release/configguide/index + ../submodules/netready/docs/development/overview/index + ../submodules/netready/docs/development/requirements/index ../submodules/netready/docs/release/installation/index + ../submodules/netready/docs/release/configguide/index ../submodules/netready/docs/release/userguide/index ../submodules/netready/docs/development/design/index ../submodules/netready/docs/development/manuals/index - ../submodules/netready/docs/development/overview/index - ../submodules/netready/docs/development/requirements/index -ONOS + +Octopus ------- .. toctree:: :maxdepth: 1 - ../submodules/onosfw/docs/installationprocedure/index - ../submodules/onosfw/docs/design/index - ../submodules/onosfw/docs/userguide/index + ../submodules/octopus/docs/development/overview/index + ../submodules/octopus/docs/development/requirements/index + ../submodules/octopus/docs/release/installation/index + ../submodules/octopus/docs/release/configguide/index + ../submodules/octopus/docs/release/userguide/index + ../submodules/octopus/docs/development/design/index + ../submodules/octopus/docs/development/manuals/index -OVSNFV --------- +Onosfw +------ .. toctree:: :maxdepth: 1 - ../submodules/ovsnfv/docs/release/configguide/index + ../submodules/onosfw/docs/development/overview/index + ../submodules/onosfw/docs/development/requirements/index + ../submodules/onosfw/docs/release/installation/index + ../submodules/onosfw/docs/release/configguide/index + ../submodules/onosfw/docs/release/userguide/index + ../submodules/onosfw/docs/development/design/index + ../submodules/onosfw/docs/development/manuals/index + + +Opera +----- +.. toctree:: + :maxdepth: 1 + + ../submodules/opera/docs/development/overview/index + ../submodules/opera/docs/development/requirements/index + ../submodules/opera/docs/release/installation/index + ../submodules/opera/docs/release/configguide/index + ../submodules/opera/docs/release/userguide/index + ../submodules/opera/docs/development/design/index + ../submodules/opera/docs/development/manuals/index + + +Ovsnfv +------ +.. toctree:: + :maxdepth: 1 + + ../submodules/ovsnfv/docs/development/overview/index + ../submodules/ovsnfv/docs/development/requirements/index ../submodules/ovsnfv/docs/release/installation/index + ../submodules/ovsnfv/docs/release/configguide/index ../submodules/ovsnfv/docs/release/userguide/index ../submodules/ovsnfv/docs/development/design/index ../submodules/ovsnfv/docs/development/manuals/index - ../submodules/ovsnfv/docs/development/overview/index - ../submodules/ovsnfv/docs/development/requirements/index Parser --------- +------ .. toctree:: :maxdepth: 1 - ../submodules/parser/docs/release/configguide/index + ../submodules/parser/docs/development/overview/index + ../submodules/parser/docs/development/requirements/index ../submodules/parser/docs/release/installation/index + ../submodules/parser/docs/release/configguide/index ../submodules/parser/docs/release/userguide/index ../submodules/parser/docs/development/design/index ../submodules/parser/docs/development/manuals/index - ../submodules/parser/docs/development/overview/index - ../submodules/parser/docs/development/requirements/index Pharos --------- +------ .. toctree:: :maxdepth: 1 - ../submodules/pharos/docs/platformoverview/index - ../submodules/pharos/docs/specification/index + ../submodules/pharos/docs/development/overview/index + ../submodules/pharos/docs/development/requirements/index + ../submodules/pharos/docs/release/installation/index + ../submodules/pharos/docs/release/configguide/index + ../submodules/pharos/docs/release/userguide/index + ../submodules/pharos/docs/development/design/index + ../submodules/pharos/docs/development/manuals/index -SDNVPN --------- +Promise +------- .. toctree:: :maxdepth: 1 - ../submodules/sdnvpn/docs/release-notes/index - ../submodules/sdnvpn/docs/userguide/index + ../submodules/promise/docs/development/overview/index + ../submodules/promise/docs/development/requirements/index + ../submodules/promise/docs/release/installation/index + ../submodules/promise/docs/release/configguide/index + ../submodules/promise/docs/release/userguide/index + ../submodules/promise/docs/development/design/index + ../submodules/promise/docs/development/manuals/index -SFC ------ +Qtip +---- .. toctree:: :maxdepth: 1 - ../submodules/sfc/docs/release/configguide/index + ../submodules/qtip/docs/development/overview/index + ../submodules/qtip/docs/development/requirements/index + ../submodules/qtip/docs/release/installation/index + ../submodules/qtip/docs/release/configguide/index + ../submodules/qtip/docs/release/userguide/index + ../submodules/qtip/docs/development/design/index + ../submodules/qtip/docs/development/manuals/index + + +Releng +------ +.. toctree:: + :maxdepth: 1 + + ../submodules/releng/docs/development/overview/index + ../submodules/releng/docs/development/requirements/index + ../submodules/releng/docs/release/installation/index + ../submodules/releng/docs/release/configguide/index + ../submodules/releng/docs/release/userguide/index + ../submodules/releng/docs/development/design/index + ../submodules/releng/docs/development/manuals/index + + +Sdnvpn +------ +.. toctree:: + :maxdepth: 1 + + ../submodules/sdnvpn/docs/development/overview/index + ../submodules/sdnvpn/docs/development/requirements/index + ../submodules/sdnvpn/docs/release/installation/index + ../submodules/sdnvpn/docs/release/configguide/index + ../submodules/sdnvpn/docs/release/userguide/index + ../submodules/sdnvpn/docs/development/design/index + ../submodules/sdnvpn/docs/development/manuals/index + + +Sfc +--- +.. toctree:: + :maxdepth: 1 + + ../submodules/sfc/docs/development/overview/index + ../submodules/sfc/docs/development/requirements/index ../submodules/sfc/docs/release/installation/index + ../submodules/sfc/docs/release/configguide/index ../submodules/sfc/docs/release/userguide/index ../submodules/sfc/docs/development/design/index ../submodules/sfc/docs/development/manuals/index - ../submodules/sfc/docs/development/overview/index - ../submodules/sfc/docs/development/requirements/index + + +Snaps +----- +.. toctree:: + :maxdepth: 1 + + ../submodules/snaps/docs/development/overview/index + ../submodules/snaps/docs/development/requirements/index + ../submodules/snaps/docs/release/installation/index + ../submodules/snaps/docs/release/configguide/index + ../submodules/snaps/docs/release/userguide/index + ../submodules/snaps/docs/development/design/index + ../submodules/snaps/docs/development/manuals/index + + +Storperf +-------- +.. toctree:: + :maxdepth: 1 + + ../submodules/storperf/docs/development/overview/index + ../submodules/storperf/docs/development/requirements/index + ../submodules/storperf/docs/release/installation/index + ../submodules/storperf/docs/release/configguide/index + ../submodules/storperf/docs/release/userguide/index + ../submodules/storperf/docs/development/design/index + ../submodules/storperf/docs/development/manuals/index + + +Ves +--- +.. toctree:: + :maxdepth: 1 + + ../submodules/ves/docs/development/overview/index + ../submodules/ves/docs/development/requirements/index + ../submodules/ves/docs/release/installation/index + ../submodules/ves/docs/release/configguide/index + ../submodules/ves/docs/release/userguide/index + ../submodules/ves/docs/development/design/index + ../submodules/ves/docs/development/manuals/index + + +Vnf Forwarding Graph +-------------------- +.. toctree:: + :maxdepth: 1 + + ../submodules/vnf_forwarding_graph/docs/development/overview/index + ../submodules/vnf_forwarding_graph/docs/development/requirements/index + ../submodules/vnf_forwarding_graph/docs/release/installation/index + ../submodules/vnf_forwarding_graph/docs/release/configguide/index + ../submodules/vnf_forwarding_graph/docs/release/userguide/index + ../submodules/vnf_forwarding_graph/docs/development/design/index + ../submodules/vnf_forwarding_graph/docs/development/manuals/index + + +Vswitchperf +----------- +.. toctree:: + :maxdepth: 1 + + ../submodules/vswitchperf/docs/development/overview/index + ../submodules/vswitchperf/docs/development/requirements/index + ../submodules/vswitchperf/docs/release/installation/index + ../submodules/vswitchperf/docs/release/configguide/index + ../submodules/vswitchperf/docs/release/userguide/index + ../submodules/vswitchperf/docs/development/design/index + ../submodules/vswitchperf/docs/development/manuals/index + + +Yardstick +--------- +.. toctree:: + :maxdepth: 1 + + ../submodules/yardstick/docs/development/overview/index + ../submodules/yardstick/docs/development/requirements/index + ../submodules/yardstick/docs/release/installation/index + ../submodules/yardstick/docs/release/configguide/index + ../submodules/yardstick/docs/release/userguide/index + ../submodules/yardstick/docs/development/design/index + ../submodules/yardstick/docs/development/manuals/index + diff --git a/docs/release/release-notes.rst b/docs/release/release-notes.rst index 46f5901d3..02ba32fbf 100644 --- a/docs/release/release-notes.rst +++ b/docs/release/release-notes.rst @@ -169,9 +169,9 @@ Vnf_Forwarding_Graph ------------------- :ref:`Vnf_Forwarding_Graph Release Notes <vnf_forwarding_graph-releasenotes>` -Vswitchperf +VSPERF ------------ -:ref:`Vswitchperf Release Notes <vswitchperf-releasenotes>` +:ref:`VSPERF Release Notes <vswitchperf-releasenotes>` Yardstick ---------- diff --git a/docs/release/userguide.introduction.rst b/docs/release/userguide.introduction.rst index 0408099db..d143a743f 100644 --- a/docs/release/userguide.introduction.rst +++ b/docs/release/userguide.introduction.rst @@ -61,10 +61,8 @@ Feature Configuration Guides - :ref:`Doctor Configuration Guide <doctor-configguide>` - :ref:`IPv6 Configuration Guide <ipv6-configguide>` - :ref:`KVMforNFV Configuration Guide <kvmfornfv-configguide>` -- :ref:`Moon Configuration Guide <moon-configguide>` - :ref:`Multisite Configuration Guide <multisite-configguide>` - :ref:`ONOSFW Configuration Guide <onosfw-configguide>` -- :ref:`OVSNFV Configuration Guide <ovsnfv-configguide>` - :ref:`Promise Configuration Guide <promise-configguide>` - :ref:`SFC Configuration Guide <sfc-configguide>` @@ -77,10 +75,8 @@ Feature User Guides - :ref:`Domino User Guide <domino-userguide>` - :ref:`IPv6 User Guide <ipv6-userguide>` - :ref:`KVMforNFV User Guide <kvmfornfv-userguide>` -- :ref:`Moon User Guide <moon-userguide>` - :ref:`Multisite User Guide <multisite-userguide>` - :ref:`ONOSFW User Guide <onosfw-userguide>` -- :ref:`OVSNFV User Guide <ovsnfv-userguide>` - :ref:`Parser User Guide <parser-userguide>` - :ref:`Promise User Guide <promise-userguide>` - :ref:`SDNVPN User Guide <sdnvpn-userguide>` diff --git a/docs/testing/testing-dev.rst b/docs/testing/testing-dev.rst index 11f6bd029..970abe2ae 100644 --- a/docs/testing/testing-dev.rst +++ b/docs/testing/testing-dev.rst @@ -35,3 +35,11 @@ QTIP :maxdepth: 1 ../submodules/qtip/docs/testing/developer/devguide/index + + +VSPERF +------- +.. toctree:: + :maxdepth: 1 + + ../submodules/vswitchperf/docs/testing/developer/index diff --git a/docs/testing/testing-user.rst b/docs/testing/testing-user.rst index 52042ba5b..8e69a482d 100644 --- a/docs/testing/testing-user.rst +++ b/docs/testing/testing-user.rst @@ -10,8 +10,8 @@ Functest .. toctree:: :maxdepth: 1 - ../submodules/functest/docs/testing/user/userguide/index ../submodules/functest/docs/testing/user/configguide/index + ../submodules/functest/docs/testing/user/userguide/index Bottlenecks @@ -19,8 +19,8 @@ Bottlenecks .. toctree:: :maxdepth: 1 - ../submodules/bottlenecks/docs/testing/user/userguide/index ../submodules/bottlenecks/docs/testing/user/configguide/index + ../submodules/bottlenecks/docs/testing/user/userguide/index Yardstick @@ -28,8 +28,8 @@ Yardstick .. toctree:: :maxdepth: 1 - ../submodules/yardstick/docs/testing/user/userguide/index ../submodules/yardstick/docs/testing/user/configguide/index + ../submodules/yardstick/docs/testing/user/userguide/index QTIP @@ -37,5 +37,15 @@ QTIP .. toctree:: :maxdepth: 1 + ../submodules/qtip/docs/testing/user/configguide/index ../submodules/qtip/docs/testing/user/userguide/index - ../submodules/qtip/docs/testing/user/configguide/index
\ No newline at end of file + + +VSPERF +------ + +.. toctree:: + :maxdepth: 1 + + ../submodules/vswitchperf/docs/testing/user/configguide/index + ../submodules/vswitchperf/docs/testing/user/userguide/index |