diff options
| -rw-r--r-- | .gitmodules | 25 | ||||
| -rw-r--r-- | docs/conf.py | 40 | ||||
| -rw-r--r-- | docs/glossary/index.rst | 6 | ||||
| -rw-r--r-- | docs/requirements.txt | 2 | ||||
| m--------- | docs/submodules/joid | 0 | ||||
| m--------- | docs/submodules/opera | 0 | ||||
| m--------- | docs/submodules/ovsnfv | 0 | ||||
| m--------- | docs/submodules/ves | 0 | ||||
| m--------- | docs/submodules/vnf_forwarding_graph | 0 | ||||
| -rw-r--r-- | docs/testing/testing-dev.rst | 6 | ||||
| -rw-r--r-- | docs/testing/testing-user.rst | 12 |
11 files changed, 33 insertions, 58 deletions
diff --git a/.gitmodules b/.gitmodules index 7aac57010..e69de29bb 100644 --- a/.gitmodules +++ b/.gitmodules @@ -1,25 +0,0 @@ -[submodule "docs/submodules/joid"] - path = docs/submodules/joid - url = ../joid - branch = . - ignore = dirty -[submodule "docs/submodules/ovsnfv"] - path = docs/submodules/ovsnfv - url = ../ovsnfv - branch = . - ignore = dirty -[submodule "docs/submodules/ves"] - path = docs/submodules/ves - url = ../ves - branch = . - ignore = dirty -[submodule "docs/submodules/vnf_forwarding_graph"] - path = docs/submodules/vnf_forwarding_graph - url = ../vnf_forwarding_graph - branch = . - ignore = dirty -[submodule "docs/submodules/opera"] - path = docs/submodules/opera - url = ../opera - branch = . - ignore = dirty diff --git a/docs/conf.py b/docs/conf.py index d590ac475..43e8388f0 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -56,7 +56,7 @@ branch = 'latest' # # This is also used if you do content translation via gettext catalogs. # Usually you set "language" from the command line for these cases. -language = None +language = 'en' # There are two options for replacing |today|: either, you set today to some # non-false value, then it is used: @@ -200,7 +200,7 @@ html_static_path = ['_static'] # html_search_scorer = 'scorer.js' # Output file base name for HTML help builder. -htmlhelp_basename = 'OPNFV' +htmlhelp_basename = 'Anuket' # -- Options for LaTeX output --------------------------------------------- @@ -222,8 +222,8 @@ latex_elements = { # (source start file, target name, title, # author, documentclass [howto, manual, or own class]). latex_documents = [ - (master_doc, 'OPNFV.tex', 'OPNFV Documentation', - 'OPNFV Project', 'manual'), + (master_doc, 'Anuket.tex', 'Anuket Documentation', + 'Anuket Project', 'manual'), ] # The name of an image file (relative to this directory) to place at the top of @@ -252,7 +252,7 @@ latex_documents = [ # One entry per manual page. List of tuples # (source start file, name, description, authors, manual section). man_pages = [ - (master_doc, 'OPNFVDocs', 'OPNFV Documentation', + (master_doc, 'AnuketDocs', 'Anuket Documentation', [author], 1) ] @@ -266,9 +266,9 @@ man_pages = [ # (source start file, target name, title, author, # dir menu entry, description, category) texinfo_documents = [ - (master_doc, 'OPNFVDocs', 'OPNFV Documentation', - author, 'OPNFV', 'One line description of project.', - 'Miscellaneous'), + (master_doc, 'AnuketDocs', 'Anuket Documentation', + author, 'Anuket', '', + ''), ] html_sidebars = {'**': ['localtoc.html', 'relations.html'],} @@ -285,31 +285,31 @@ html_sidebars = {'**': ['localtoc.html', 'relations.html'],} # texinfo_no_detailmenu = False intersphinx_mapping = {} -intersphinx_mapping['airship'] = ('https://opnfv-airship.readthedocs.io/en/%s' % branch, None) +intersphinx_mapping['airship'] = ('https://docs.anuket.io/projects/airship/en/%s' % branch, None) #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://docs.anuket.io/projects/auto/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['barometer'] = ('https://docs.anuket.io/projects/barometer/en/%s' % branch, None) #intersphinx_mapping['bottlenecks'] = ('https://opnfv-bottlenecks.readthedocs.io/en/%s' % branch, None) -intersphinx_mapping['calipso'] = ('https://opnfv-calipso.readthedocs.io/en/%s' % branch, None) -intersphinx_mapping['cirv-sdv'] = ('https://opnfv-cirv-sdv.readthedocs.io/en/%s' % branch, None) +intersphinx_mapping['calipso'] = ('https://docs.anuket.io/projects/calipso/en/%s' % branch, None) +intersphinx_mapping['cirv-sdv'] = ('https://docs.anuket.io/projects/cirv-sdv/en/%s' % branch, None) #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['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['dovetail'] = ('https://docs.anuket.io/projects/dovetail/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['fuel'] = ('https://opnfv-fuel.readthedocs.io/en/%s' % branch, None) -intersphinx_mapping['functest'] = ('https://opnfv-functest.readthedocs.io/en/%s' % branch, None) +intersphinx_mapping['functest'] = ('https://docs.anuket.io/projects/functest/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['kuberef'] = ('https://opnfv-kuberef.readthedocs.io/en/%s' % branch, None) -intersphinx_mapping['nfvbench'] = ('https://opnfv-nfvbench.readthedocs.io/en/%s' % branch, None) +intersphinx_mapping['kuberef'] = ('https://docs.anuket.io/projects/kuberef/en/%s' % branch, None) +intersphinx_mapping['nfvbench'] = ('https://docs.anuket.io/projects/nfvbench/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) intersphinx_mapping['ovn4nfv'] = ('https://opnfv-ovn4nfv.readthedocs.io/en/%s' % branch, None) @@ -318,13 +318,13 @@ intersphinx_mapping['parser'] = ('https://opnfv-parser.readthedocs.io/en/%s' % b intersphinx_mapping['pharos'] = ('https://opnfv-pharos.readthedocs.io/en/%s' % branch, None) #intersphinx_mapping['promise'] = ('https://opnfv-promise.readthedocs.io/en/%s' % branch, None) #intersphinx_mapping['qtip'] = ('https://opnfv-qtip.readthedocs.io/en/%s' % branch, None) -intersphinx_mapping['releng'] = ('https://opnfv-releng.readthedocs.io/en/latest', None) +intersphinx_mapping['releng'] = ('https://docs.anuket.io/projects/releng/en/latest', None) intersphinx_mapping['releng-xci'] = ('https://opnfv-releng-xci.readthedocs.io/en/%s' % branch, None) -intersphinx_mapping['samplevnf'] = ('https://opnfv-samplevnf.readthedocs.io/en/%s' % branch, None) +intersphinx_mapping['samplevnf'] = ('https://docs.anuket.io/projects/samplevnf/en/%s' % branch, None) intersphinx_mapping['sdnvpn'] = ('https://opnfv-sdnvpn.readthedocs.io/en/%s' % branch, None) #intersphinx_mapping['sfc'] = ('https://opnfv-sfc.readthedocs.io/en/%s' % branch, None) #intersphinx_mapping['snaps'] = ('https://opnfv-snaps.readthedocs.io/en/%s' % branch, None) intersphinx_mapping['stor4nfv'] = ('https://opnfv-stor4nfv.readthedocs.io/en/%s' % branch, None) #intersphinx_mapping['storperf'] = ('https://opnfv-storperf.readthedocs.io/en/%s' % branch, None) -intersphinx_mapping['vineperf'] = ('https://opnfv-vineperf.readthedocs.io/en/%s' % branch, None) +intersphinx_mapping['vineperf'] = ('https://docs.anuket.io/projects/vineperf/en/%s' % branch, None) #intersphinx_mapping['yardstick'] = ('https://opnfv-yardstick.readthedocs.io/en/%s' % branch, None) diff --git a/docs/glossary/index.rst b/docs/glossary/index.rst index 0d8616970..1ee12de02 100644 --- a/docs/glossary/index.rst +++ b/docs/glossary/index.rst @@ -3,9 +3,9 @@ .. SPDX-License-Identifier: CC-BY-4.0 .. (c) Christopher Price (Ericsson AB), AT&T, Anuket -************************************* -OPNFV and Anuket Development Glossary -************************************* +*************************** +Anuket Development Glossary +*************************** ======== Contents diff --git a/docs/requirements.txt b/docs/requirements.txt index 734f07f97..f52cfe718 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -5,4 +5,4 @@ docutils==0.12 setuptools six sphinxcontrib-httpdomain -sphinx_bootstrap_theme>=0.4.11 +sphinx_bootstrap_theme>=0.4.11
\ No newline at end of file diff --git a/docs/submodules/joid b/docs/submodules/joid deleted file mode 160000 -Subproject f22b547900c6dacd937cdb1e53bacd39c6f56f6 diff --git a/docs/submodules/opera b/docs/submodules/opera deleted file mode 160000 -Subproject ff99375929fe94e4a1ffe50fab103b39b90fdd2 diff --git a/docs/submodules/ovsnfv b/docs/submodules/ovsnfv deleted file mode 160000 -Subproject 5b7a8fe64efa5d1bc32a0c5328e073463fd2393 diff --git a/docs/submodules/ves b/docs/submodules/ves deleted file mode 160000 -Subproject 3cdd68d998fd317c4e51821b34028bbb02018ff diff --git a/docs/submodules/vnf_forwarding_graph b/docs/submodules/vnf_forwarding_graph deleted file mode 160000 -Subproject 237b13c7fbaf4fa856d32d000ef1122290c8b3f diff --git a/docs/testing/testing-dev.rst b/docs/testing/testing-dev.rst index 1616bad4a..80ac3e3d1 100644 --- a/docs/testing/testing-dev.rst +++ b/docs/testing/testing-dev.rst @@ -14,12 +14,12 @@ Testing group ./developer/devguide/index -OPNFV Verified Program –> Anuket Assured Program ------------------------------------------------- +Anuket Assured Program +---------------------- * OVP releases were on a separate schedule from OPNFV. You may find the current status and latest documentation for OVP at - `<http://verified.opnfv.org>`_. The next incarnation of OVP will be the + `<https://nfvi-verified.lfnetworking.org/>`_. The next incarnation of OVP will be the Anuket Assured Program. Functest diff --git a/docs/testing/testing-user.rst b/docs/testing/testing-user.rst index b527d39e1..5efe3c3e9 100644 --- a/docs/testing/testing-user.rst +++ b/docs/testing/testing-user.rst @@ -10,14 +10,14 @@ Testing User Guides This page provides the links to the installation, configuration and user guides of the different test projects. -OPNFV Verified Program --> Anuket Assured Program -------------------------------------------------- +Anuket Assured Program +---------------------- .. toctree:: :maxdepth: 1 -* OVP releases were on a separate schedule from OPNFV. You may find +* OVP releases were on a separate schedule from OPNFV. You may find the current status and latest documentation for OVP at - `<http://verified.opnfv.org>`_. The next incarnation of OVP will be the + `<https://nfvi-verified.lfnetworking.org/>`_. The next incarnation of OVP will be the Anuket Assured Program. Functest @@ -35,8 +35,8 @@ SampleVNF * :doc:`SampleVNF User Guide <samplevnf:testing/user/userguide/index>` -VSPERF ------- +ViNePERF +-------- .. toctree:: :maxdepth: 1 |