docs: better docs, mv doxygen to sphinx 45/33545/25
authorNathan Skrzypczak <nathan.skrzypczak@gmail.com>
Thu, 19 Aug 2021 09:38:06 +0000 (11:38 +0200)
committerDave Wallace <dwallacelf@gmail.com>
Wed, 13 Oct 2021 23:22:32 +0000 (23:22 +0000)
commit9ad39c026c8a3c945a7003c4aa4f5cb1d4c80160
tree3cca19635417e28ae381d67ae31c75df2925032d
parentf47122e07e1ecd0151902a3cabe46c60a99bee8e
docs: better docs, mv doxygen to sphinx

This patch refactors the VPP sphinx docs
in order to make it easier to consume
for external readers as well as VPP developers.

It also makes sphinx the single source
of documentation, which simplifies maintenance
and operation.

Most important updates are:

- reformat the existing documentation as rst
- split RELEASE.md and move it into separate rst files
- remove section 'events'
- remove section 'archive'
- remove section 'related projects'
- remove section 'feature by release'
- remove section 'Various links'
- make (Configuration reference, CLI docs,
  developer docs) top level items in the list
- move 'Use Cases' as part of 'About VPP'
- move 'Troubleshooting' as part of 'Getting Started'
- move test framework docs into 'Developer Documentation'
- add a 'Contributing' section for gerrit,
  docs and other contributer related infos
- deprecate doxygen and test-docs targets
- redirect the "make doxygen" target to "make docs"

Type: refactor

Change-Id: I552a5645d5b7964d547f99b1336e2ac24e7c209f
Signed-off-by: Nathan Skrzypczak <nathan.skrzypczak@gmail.com>
Signed-off-by: Andrew Yourtchenko <ayourtch@gmail.com>
388 files changed:
.gitignore
MAINTAINERS
Makefile
README.md
RELEASE.md [deleted file]
docs/Makefile
docs/README
docs/_images/htmlBuild.png [deleted file]
docs/_images/libmemif_architecture.png [new symlink]
docs/_scripts/Makefile [new file with mode: 0644]
docs/_scripts/filter_api.py [moved from doxygen/filter_api.py with 100% similarity]
docs/_scripts/filter_c.py [moved from doxygen/filter_c.py with 100% similarity]
docs/_scripts/filter_h.py [moved from doxygen/filter_h.py with 100% similarity]
docs/_scripts/includes_renderer.py [new file with mode: 0644]
docs/_scripts/prepare-for-site.sh [moved from docs/scripts/prepare-for-site.sh with 100% similarity]
docs/_scripts/publish-docs.sh [moved from docs/scripts/publish-docs.sh with 98% similarity]
docs/_scripts/siphon-generate [moved from doxygen/siphon-generate with 100% similarity]
docs/_scripts/siphon-process [moved from doxygen/siphon-process with 81% similarity]
docs/_scripts/siphon/__init__.py [moved from doxygen/siphon/__init__.py with 100% similarity]
docs/_scripts/siphon/generate.py [moved from doxygen/siphon/generate.py with 100% similarity]
docs/_scripts/siphon/generate_clicmd.py [moved from doxygen/siphon/generate_clicmd.py with 100% similarity]
docs/_scripts/siphon/generate_syscfg.py [moved from doxygen/siphon/generate_syscfg.py with 100% similarity]
docs/_scripts/siphon/parsers.py [moved from doxygen/siphon/parsers.py with 100% similarity]
docs/_scripts/siphon/process.py [moved from doxygen/siphon/process.py with 74% similarity]
docs/_scripts/siphon/process_clicmd.py [moved from doxygen/siphon/process_clicmd.py with 73% similarity]
docs/_scripts/siphon/process_syscfg.py [moved from doxygen/siphon/process_syscfg.py with 100% similarity]
docs/_scripts/siphon_templates/markdown/clicmd/index_entry.md [moved from doxygen/siphon_templates/itemlist/default/index_header.itemlist with 99% similarity]
docs/_scripts/siphon_templates/markdown/clicmd/index_header.md [moved from doxygen/siphon_templates/itemlist/default/index_entry.itemlist with 89% similarity]
docs/_scripts/siphon_templates/markdown/clicmd/index_section.md [moved from doxygen/siphon_templates/itemlist/default/index_section.itemlist with 94% similarity]
docs/_scripts/siphon_templates/markdown/clicmd/item_format.md [moved from doxygen/siphon_templates/markdown/clicmd/item_format.md with 66% similarity]
docs/_scripts/siphon_templates/markdown/clicmd/item_header.md [moved from doxygen/siphon_templates/itemlist/clicmd/item_format.itemlist with 76% similarity]
docs/_scripts/siphon_templates/markdown/default/index_entry.md [moved from doxygen/siphon_templates/markdown/default/index_entry.md with 100% similarity]
docs/_scripts/siphon_templates/markdown/default/index_section.md [moved from doxygen/siphon_templates/markdown/default/index_section.md with 100% similarity]
docs/_scripts/siphon_templates/markdown/default/item_format.md [moved from doxygen/siphon_templates/markdown/default/item_format.md with 100% similarity]
docs/_scripts/siphon_templates/markdown/default/item_header.md [moved from doxygen/siphon_templates/markdown/default/item_header.md with 100% similarity]
docs/_scripts/siphon_templates/markdown/syscfg/index_header.md [moved from doxygen/siphon_templates/markdown/syscfg/index_header.md with 100% similarity]
docs/_scripts/siphon_templates/markdown/syscfg/item_format.md [moved from doxygen/siphon_templates/markdown/syscfg/item_format.md with 100% similarity]
docs/about.rst [deleted file]
docs/aboutvpp/developer.rst [moved from docs/whatisvpp/developer.rst with 94% similarity]
docs/aboutvpp/extensible.rst [moved from docs/whatisvpp/extensible.rst with 89% similarity]
docs/aboutvpp/hoststack.rst [moved from docs/whatisvpp/hoststack.rst with 90% similarity]
docs/aboutvpp/networkstack.rst [moved from docs/whatisvpp/networkstack.rst with 82% similarity]
docs/aboutvpp/performance.rst [moved from docs/whatisvpp/performance.rst with 91% similarity]
docs/aboutvpp/releasenotes/index.rst [new file with mode: 0644]
docs/aboutvpp/releasenotes/past.rst [new file with mode: 0644]
docs/aboutvpp/releasenotes/v16.06.rst [new file with mode: 0644]
docs/aboutvpp/releasenotes/v16.09.rst [new file with mode: 0644]
docs/aboutvpp/releasenotes/v17.01.1.rst [new file with mode: 0644]
docs/aboutvpp/releasenotes/v17.01.rst [new file with mode: 0644]
docs/aboutvpp/releasenotes/v17.04.rst [new file with mode: 0644]
docs/aboutvpp/releasenotes/v17.07.rst [new file with mode: 0644]
docs/aboutvpp/releasenotes/v17.10.rst [new file with mode: 0644]
docs/aboutvpp/releasenotes/v18.01.1.rst [new file with mode: 0644]
docs/aboutvpp/releasenotes/v18.01.2.rst [new file with mode: 0644]
docs/aboutvpp/releasenotes/v18.01.rst [new file with mode: 0644]
docs/aboutvpp/releasenotes/v18.04.rst [new file with mode: 0644]
docs/aboutvpp/releasenotes/v18.07.rst [new file with mode: 0644]
docs/aboutvpp/releasenotes/v18.10.rst [new file with mode: 0644]
docs/aboutvpp/releasenotes/v19.01.1.rst [new file with mode: 0644]
docs/aboutvpp/releasenotes/v19.01.2.rst [new file with mode: 0644]
docs/aboutvpp/releasenotes/v19.01.3.rst [new file with mode: 0644]
docs/aboutvpp/releasenotes/v19.01.rst [new file with mode: 0644]
docs/aboutvpp/releasenotes/v19.04.1.rst [new file with mode: 0644]
docs/aboutvpp/releasenotes/v19.04.2.rst [new file with mode: 0644]
docs/aboutvpp/releasenotes/v19.04.3.rst [new file with mode: 0644]
docs/aboutvpp/releasenotes/v19.04.rst [new file with mode: 0644]
docs/aboutvpp/releasenotes/v19.08.1.rst [new file with mode: 0644]
docs/aboutvpp/releasenotes/v19.08.2.rst [new file with mode: 0644]
docs/aboutvpp/releasenotes/v19.08.3.rst [new file with mode: 0644]
docs/aboutvpp/releasenotes/v19.08.rst [new file with mode: 0644]
docs/aboutvpp/releasenotes/v20.01.rst [new file with mode: 0644]
docs/aboutvpp/releasenotes/v20.05.1.rst [new file with mode: 0644]
docs/aboutvpp/releasenotes/v20.05.rst [new file with mode: 0644]
docs/aboutvpp/releasenotes/v20.09.rst [new file with mode: 0644]
docs/aboutvpp/releasenotes/v21.01.rst [new file with mode: 0644]
docs/aboutvpp/releasenotes/v21.06.rst [new file with mode: 0644]
docs/aboutvpp/releasenotes/v21.10.rst [new file with mode: 0644]
docs/aboutvpp/scalar-vs-vector-packet-processing.rst [moved from docs/whatisvpp/scalar-vs-vector-packet-processing.rst with 97% similarity]
docs/aboutvpp/supported.rst [moved from docs/whatisvpp/supported.rst with 72% similarity]
docs/cli-reference/gettingstarted/index.rst [new file with mode: 0644]
docs/cli-reference/interface/basic.rst [moved from docs/reference/cmdreference/interface/basic.rst with 97% similarity]
docs/cli-reference/interface/create_interface.rst [moved from docs/reference/cmdreference/interface/create_interface.rst with 93% similarity]
docs/cli-reference/interface/hardware.rst [moved from docs/reference/cmdreference/interface/hardware.rst with 95% similarity]
docs/cli-reference/interface/index.rst [moved from docs/reference/cmdreference/interface/index.rst with 98% similarity]
docs/cli-reference/interface/setinterface.rst [new file with mode: 0644]
docs/conf.py
docs/configuration/config_getting_started.rst [new file with mode: 0644]
docs/configuration/reference.rst [moved from docs/gettingstarted/users/configuring/startup.rst with 93% similarity]
docs/contributing/gitreview.rst [moved from docs/gettingstarted/developers/gitreview.rst with 98% similarity]
docs/contributing/reportingissues/index.rst [new file with mode: 0644]
docs/contributing/reportingissues/reportingissues.rst [moved from docs/troubleshooting/reportingissues/reportingissues.rst with 91% similarity]
docs/contributing/writingdocs.rst [new file with mode: 0644]
docs/developer/build-run-debug/building.rst [moved from docs/gettingstarted/developers/building.rst with 97% similarity]
docs/developer/build-run-debug/cross_compile_macos.rst [moved from docs/gettingstarted/developers/cross_compile_macos.rst with 100% similarity]
docs/developer/build-run-debug/gdb_examples.rst [moved from docs/gettingstarted/developers/gdb_examples.rst with 98% similarity]
docs/developer/build-run-debug/index.rst [new file with mode: 0644]
docs/developer/build-run-debug/running_vpp.rst [moved from docs/gettingstarted/developers/running_vpp.rst with 100% similarity]
docs/developer/build-run-debug/testing_vpp.rst [new file with mode: 0644]
docs/developer/corearchitecture/bihash.rst [new file with mode: 0644]
docs/developer/corearchitecture/buffer_metadata.rst [new file with mode: 0644]
docs/developer/corearchitecture/buildsystem/buildrootmakefile.rst [moved from docs/gettingstarted/developers/buildsystem/buildrootmakefile.rst with 98% similarity]
docs/developer/corearchitecture/buildsystem/cmakeandninja.rst [moved from docs/gettingstarted/developers/buildsystem/cmakeandninja.rst with 100% similarity]
docs/developer/corearchitecture/buildsystem/index.rst [moved from docs/gettingstarted/developers/buildsystem/index.rst with 100% similarity]
docs/developer/corearchitecture/buildsystem/mainmakefile.rst [moved from docs/gettingstarted/developers/buildsystem/mainmakefile.md with 98% similarity]
docs/developer/corearchitecture/featurearcs.rst [new file with mode: 0644]
docs/developer/corearchitecture/index.rst [new file with mode: 0644]
docs/developer/corearchitecture/infrastructure.rst [new file with mode: 0644]
docs/developer/corearchitecture/mem.rst [new symlink]
docs/developer/corearchitecture/multi_thread.rst [new file with mode: 0644]
docs/developer/corearchitecture/multiarch/arbfns.rst [moved from docs/gettingstarted/developers/multiarch/arbfns.rst with 100% similarity]
docs/developer/corearchitecture/multiarch/index.rst [moved from docs/gettingstarted/developers/multiarch/index.rst with 100% similarity]
docs/developer/corearchitecture/multiarch/nodefns.rst [moved from docs/gettingstarted/developers/multiarch/nodefns.rst with 97% similarity]
docs/developer/corearchitecture/softwarearchitecture.rst [moved from docs/gettingstarted/developers/softwarearchitecture.md with 52% similarity]
docs/developer/corearchitecture/vlib.rst [new file with mode: 0644]
docs/developer/corearchitecture/vnet.rst [new file with mode: 0644]
docs/developer/corefeatures/bfd_doc.rst [new symlink]
docs/developer/corefeatures/eventviewer.rst [moved from docs/gettingstarted/developers/eventviewer.rst with 97% similarity]
docs/developer/corefeatures/fib/attachedexport.rst [moved from docs/gettingstarted/developers/fib20/attachedexport.rst with 100% similarity]
docs/developer/corefeatures/fib/barnacles.rst [moved from docs/gettingstarted/developers/fib20/barnacles.rst with 97% similarity]
docs/developer/corefeatures/fib/controlplane.rst [moved from docs/gettingstarted/developers/fib20/controlplane.rst with 100% similarity]
docs/developer/corefeatures/fib/dataplane.rst [moved from docs/gettingstarted/developers/fib20/dataplane.rst with 96% similarity]
docs/developer/corefeatures/fib/debugging.rst [moved from docs/gettingstarted/developers/fib20/debugging.rst with 96% similarity]
docs/developer/corefeatures/fib/fastconvergence.rst [moved from docs/gettingstarted/developers/fib20/fastconvergence.rst with 98% similarity]
docs/developer/corefeatures/fib/graphs.rst [moved from docs/gettingstarted/developers/fib20/graphs.rst with 100% similarity]
docs/developer/corefeatures/fib/graphwalks.rst [moved from docs/gettingstarted/developers/fib20/graphwalks.rst with 100% similarity]
docs/developer/corefeatures/fib/hacking.rst [moved from docs/gettingstarted/developers/fib20/hacking.rst with 100% similarity]
docs/developer/corefeatures/fib/index.rst [moved from docs/gettingstarted/developers/fib20/index.rst with 65% similarity]
docs/developer/corefeatures/fib/marknsweep.rst [moved from docs/gettingstarted/developers/fib20/marknsweep.rst with 100% similarity]
docs/developer/corefeatures/fib/missing.rst [moved from docs/gettingstarted/developers/fib20/missing.rst with 98% similarity]
docs/developer/corefeatures/fib/mplsfib.rst [moved from docs/gettingstarted/developers/fib20/mplsfib.rst with 98% similarity]
docs/developer/corefeatures/fib/multicast.rst [moved from docs/gettingstarted/developers/fib20/multicast.rst with 98% similarity]
docs/developer/corefeatures/fib/neighbors.rst [moved from docs/gettingstarted/developers/fib20/neighbors.rst with 97% similarity]
docs/developer/corefeatures/fib/prefixes.rst [moved from docs/gettingstarted/developers/fib20/prefixes.rst with 100% similarity]
docs/developer/corefeatures/fib/prerequisites.rst [moved from docs/gettingstarted/developers/fib20/prerequisites.rst with 100% similarity]
docs/developer/corefeatures/fib/routes.rst [moved from docs/gettingstarted/developers/fib20/routes.rst with 98% similarity]
docs/developer/corefeatures/fib/scale.rst [moved from docs/gettingstarted/developers/fib20/scale.rst with 87% similarity]
docs/developer/corefeatures/fib/thedatamodel.rst [moved from docs/gettingstarted/developers/fib20/thedatamodel.rst with 100% similarity]
docs/developer/corefeatures/fib/tunnels.rst [moved from docs/gettingstarted/developers/fib20/tunnels.rst with 99% similarity]
docs/developer/corefeatures/index.rst [new file with mode: 0644]
docs/developer/corefeatures/ipfix_doc.rst [new symlink]
docs/developer/corefeatures/ipsec.rst [moved from docs/gettingstarted/developers/ipsec.rst with 100% similarity]
docs/developer/corefeatures/mtu.rst [new symlink]
docs/developer/corefeatures/punt.rst [moved from docs/gettingstarted/developers/punt.rst with 100% similarity]
docs/developer/corefeatures/selinux_doc.rst [new symlink]
docs/developer/corefeatures/span_doc.rst [new symlink]
docs/developer/corefeatures/sr/index.rst [new file with mode: 0644]
docs/developer/corefeatures/sr/sr_doc.rst [new symlink]
docs/developer/corefeatures/sr/sr_localsid.rst [new symlink]
docs/developer/corefeatures/sr/sr_mpls.rst [new symlink]
docs/developer/corefeatures/sr/sr_policy.rst [new symlink]
docs/developer/corefeatures/sr/sr_steering.rst [new symlink]
docs/developer/corefeatures/stats.rst [new symlink]
docs/developer/corefeatures/sylog_doc.rst [new symlink]
docs/developer/devicedrivers/af_xdp.rst [new symlink]
docs/developer/devicedrivers/avf.rst [new symlink]
docs/developer/devicedrivers/index.rst [new file with mode: 0644]
docs/developer/devicedrivers/rdma.rst [new symlink]
docs/developer/devicedrivers/vmxnet3.rst [new symlink]
docs/developer/extras/index.rst [new file with mode: 0644]
docs/developer/extras/lcov.rst [new symlink]
docs/developer/extras/snap.rst [new symlink]
docs/developer/extras/strongswan.rst [new symlink]
docs/developer/extras/vcl_ldpreload.rst [new symlink]
docs/developer/extras/vpp_config.rst [new symlink]
docs/developer/extras/vpp_if_stats.rst [new symlink]
docs/developer/extras/vpp_stats_fs.rst [new symlink]
docs/developer/extras/vpptop.rst [new symlink]
docs/developer/plugindoc/add_plugin.rst [moved from docs/gettingstarted/developers/add_plugin.rst with 100% similarity]
docs/developer/plugindoc/handoffdemo.rst [new symlink]
docs/developer/plugindoc/index.rst [new file with mode: 0644]
docs/developer/plugindoc/sample_plugin_doc.rst [new symlink]
docs/developer/plugins/acl_hash_lookup.rst [new symlink]
docs/developer/plugins/acl_lookup_context.rst [new symlink]
docs/developer/plugins/acl_multicore.rst [new symlink]
docs/developer/plugins/bufmon_doc.rst [new symlink]
docs/developer/plugins/cnat.rst [moved from docs/gettingstarted/developers/cnat.rst with 100% similarity]
docs/developer/plugins/dhcp6_pd.rst [new symlink]
docs/developer/plugins/flowprobe.rst [new symlink]
docs/developer/plugins/index.rst [moved from docs/gettingstarted/developers/plugins.rst with 56% similarity]
docs/developer/plugins/ioam.rst [new symlink]
docs/developer/plugins/lacp.rst [new symlink]
docs/developer/plugins/lb.rst [new symlink]
docs/developer/plugins/lcp.rst [new symlink]
docs/developer/plugins/lldp.rst [new symlink]
docs/developer/plugins/map_lw4o6.rst [new symlink]
docs/developer/plugins/marvell.rst [new symlink]
docs/developer/plugins/mdata.rst [new symlink]
docs/developer/plugins/nat44_ei_ha.rst [new symlink]
docs/developer/plugins/nat64.rst [new symlink]
docs/developer/plugins/pnat.rst [new symlink]
docs/developer/plugins/quic.rst [moved from docs/gettingstarted/developers/quic_plugin.rst with 100% similarity]
docs/developer/plugins/srtp.rst [new symlink]
docs/developer/plugins/srv6/ad_flow_plugin_doc.rst [new symlink]
docs/developer/plugins/srv6/ad_plugin_doc.rst [new symlink]
docs/developer/plugins/srv6/am_plugin_doc.rst [new symlink]
docs/developer/plugins/srv6/as_plugin_doc.rst [new symlink]
docs/developer/plugins/srv6/index.rst [new file with mode: 0644]
docs/developer/plugins/srv6/mobile_plugin_doc.rst [new symlink]
docs/developer/plugins/srv6/runner_doc.rst [new symlink]
docs/developer/plugins/srv6/srv6_sample_localsid_doc.rst [new symlink]
docs/developer/plugins/wireguard.rst [new symlink]
docs/developer/tests/overview.rst [moved from test/doc/overview.rst with 98% similarity]
docs/docsignore [new file with mode: 0644]
docs/dynamic_includes/.gitkeep [deleted file]
docs/gettingstarted/developers/VPPAPI.md [deleted symlink]
docs/gettingstarted/developers/bihash.md [deleted file]
docs/gettingstarted/developers/binary_api_support.rst [deleted file]
docs/gettingstarted/developers/buildwireshark.md [deleted file]
docs/gettingstarted/developers/featurearcs.md [deleted file]
docs/gettingstarted/developers/index.rst [deleted file]
docs/gettingstarted/developers/infrastructure.md [deleted file]
docs/gettingstarted/developers/metadata.md [deleted file]
docs/gettingstarted/developers/testing_vpp.md [deleted file]
docs/gettingstarted/developers/vlib.md [deleted file]
docs/gettingstarted/developers/vnet.md [deleted file]
docs/gettingstarted/developers/vpp_api_module.rst [deleted file]
docs/gettingstarted/index.rst [deleted file]
docs/gettingstarted/installing/centos.rst [deleted file]
docs/gettingstarted/installing/index.rst
docs/gettingstarted/installing/packages.rst
docs/gettingstarted/installing/ubuntu.rst
docs/gettingstarted/progressivevpp/index.rst
docs/gettingstarted/progressivevpp/interface.rst
docs/gettingstarted/progressivevpp/routing.rst
docs/gettingstarted/progressivevpp/runningvpp.rst
docs/gettingstarted/progressivevpp/settingupenvironment.rst
docs/gettingstarted/progressivevpp/switching.rst
docs/gettingstarted/progressivevpp/traces.rst
docs/gettingstarted/progressivevpp/twovppinstances.rst
docs/gettingstarted/running/index.rst [moved from docs/gettingstarted/users/configuring/hugepages.rst with 57% similarity]
docs/gettingstarted/troubleshooting/cpuusage.rst [moved from docs/troubleshooting/cpuusage.rst with 98% similarity]
docs/gettingstarted/troubleshooting/index.rst [moved from docs/troubleshooting/index.rst with 89% similarity]
docs/gettingstarted/troubleshooting/mem.rst [moved from docs/troubleshooting/mem.rst with 95% similarity]
docs/gettingstarted/troubleshooting/sanitizer.rst [moved from docs/troubleshooting/sanitizer.rst with 100% similarity]
docs/gettingstarted/users/configuring/index.rst [deleted file]
docs/gettingstarted/users/index.rst [deleted file]
docs/gettingstarted/users/running/index.rst [deleted file]
docs/gettingstarted/writingdocs/buildingrst.rst [deleted file]
docs/gettingstarted/writingdocs/index.rst [deleted file]
docs/gettingstarted/writingdocs/styleguide/index.rst [deleted file]
docs/gettingstarted/writingdocs/styleguide/iperf-vm.xml [deleted file]
docs/gettingstarted/writingdocs/styleguide/rawhtml.rst [deleted file]
docs/gettingstarted/writingdocs/styleguide/styleguide.rst [deleted file]
docs/gettingstarted/writingdocs/styleguide/styleguide02.rst [deleted file]
docs/gettingstarted/writingdocs/styleguide/styleguide02table.rst [deleted file]
docs/gettingstarted/writingdocs/styleguide/styleguide03.rst [deleted file]
docs/gettingstarted/writingdocs/styleguide/styleguide04.rst [deleted file]
docs/gettingstarted/writingdocs/styleguide/styleguide05.rst [deleted file]
docs/gettingstarted/writingdocs/styleguide/xmlexample.rst [deleted file]
docs/gettingstarted/writingdocs/styleguidemd/index.rst [deleted file]
docs/gettingstarted/writingdocs/styleguidemd/styleguide.md [deleted file]
docs/gettingstarted/writingdocs/styleguidemd/styleguide02.md [deleted file]
docs/gettingstarted/writingdocs/styleguidemd/styleguide03.md [deleted file]
docs/includes_renderer.py [deleted file]
docs/index.rst
docs/interfacing/binapi/index.rst [new file with mode: 0644]
docs/interfacing/binapi/vpp_api_language.rst [new symlink]
docs/interfacing/binapi/vpp_api_module.rst [new symlink]
docs/interfacing/binapi/writing_api_handlers.rst [new symlink]
docs/interfacing/go/add_plugin_goapi.rst [moved from docs/gettingstarted/developers/add_plugin_goapi.rst with 100% similarity]
docs/interfacing/go/index.rst [new file with mode: 0644]
docs/interfacing/libmemif/buildinstructions_doc.rst [new symlink]
docs/interfacing/libmemif/example_setup_doc.rst [new symlink]
docs/interfacing/libmemif/examples_doc.rst [new symlink]
docs/interfacing/libmemif/gettingstarted_doc.rst [new symlink]
docs/interfacing/libmemif/index.rst [new file with mode: 0644]
docs/interfacing/libmemif/libmemif_doc.rst [new symlink]
docs/interfacing/rust/index.rst [new file with mode: 0644]
docs/links/index.rst [deleted file]
docs/reference/cmdreference/index.rst [deleted file]
docs/reference/cmdreference/interface/setinterface.rst [deleted file]
docs/reference/cmdreference/ip/index.rst [deleted file]
docs/reference/cmdreference/ip/ip.rst [deleted file]
docs/reference/cmdreference/show/index.rst [deleted file]
docs/reference/cmdreference/show/show.rst [deleted file]
docs/reference/cmdreference/trace/index.rst [deleted file]
docs/reference/cmdreference/trace/trace.rst [deleted file]
docs/reference/cmdreference/vhost/index.rst [deleted file]
docs/reference/cmdreference/vhost/vhostuser.rst [deleted file]
docs/reference/github/index.rst [deleted file]
docs/reference/index.rst [deleted file]
docs/reference/readthedocs/index.rst [deleted file]
docs/reference/vppvagrant/VagrantVMSetup.rst [deleted file]
docs/reference/vppvagrant/Vagrantfile [deleted file]
docs/reference/vppvagrant/boxSetup.rst [deleted file]
docs/reference/vppvagrant/index.rst [deleted file]
docs/reference/vppvagrant/installingVboxVagrant.rst [deleted file]
docs/reference/vppvagrant/settingENV.rst [deleted file]
docs/reference/vppvagrant/vagrantOverview.rst [deleted file]
docs/reference/vppvagrant/vppVagrantfile.rst [deleted file]
docs/relatedprojects/index.rst [deleted file]
docs/scripts/sphinx-make.sh [deleted file]
docs/spelling_wordlist.txt
docs/troubleshooting/reportingissues/index.rst [deleted file]
docs/usecases/2_vpp.md [deleted file]
docs/usecases/acls.rst
docs/usecases/container_test.md [deleted file]
docs/usecases/container_test.rst [new file with mode: 0644]
docs/usecases/containers/Routing.rst [moved from docs/usecases/Routing.rst with 94% similarity]
docs/usecases/containers/containerCreation.rst [moved from docs/usecases/containerCreation.rst with 94% similarity]
docs/usecases/containers/containerSetup.rst [moved from docs/usecases/containerSetup.rst with 93% similarity]
docs/usecases/containers/index.rst [moved from docs/usecases/containers.rst with 100% similarity]
docs/usecases/contiv/BUG_REPORTS.md [deleted file]
docs/usecases/contiv/BUG_REPORTS.rst [new file with mode: 0644]
docs/usecases/contiv/CORE_FILES.md [deleted file]
docs/usecases/contiv/CORE_FILES.rst [new file with mode: 0644]
docs/usecases/contiv/CUSTOM_MGMT_NETWORK.md [deleted file]
docs/usecases/contiv/CUSTOM_MGMT_NETWORK.rst [new file with mode: 0644]
docs/usecases/contiv/K8s_Overview.md [deleted file]
docs/usecases/contiv/K8s_Overview.rst [new file with mode: 0644]
docs/usecases/contiv/MANUAL_INSTALL.md [deleted file]
docs/usecases/contiv/MANUAL_INSTALL.rst [new file with mode: 0644]
docs/usecases/contiv/MULTI_NIC_SETUP.md [deleted file]
docs/usecases/contiv/MULTI_NIC_SETUP.rst [new file with mode: 0644]
docs/usecases/contiv/NETWORKING.md [deleted file]
docs/usecases/contiv/NETWORKING.rst [new file with mode: 0644]
docs/usecases/contiv/Prometheus.md [deleted file]
docs/usecases/contiv/Prometheus.rst [new file with mode: 0644]
docs/usecases/contiv/SECURITY.md [deleted file]
docs/usecases/contiv/SECURITY.rst [new file with mode: 0644]
docs/usecases/contiv/SINGLE_NIC_SETUP.md [deleted file]
docs/usecases/contiv/SINGLE_NIC_SETUP.rst [new file with mode: 0644]
docs/usecases/contiv/VMWARE_FUSION_HOST.md [deleted file]
docs/usecases/contiv/VMWARE_FUSION_HOST.rst [new file with mode: 0644]
docs/usecases/contiv/VPPTRACE.md [deleted file]
docs/usecases/contiv/VPPTRACE.rst [new file with mode: 0644]
docs/usecases/contiv/VPP_CONFIG.md [deleted file]
docs/usecases/contiv/VPP_CONFIG.rst [new file with mode: 0644]
docs/usecases/contiv/VPP_PACKET_TRACING_K8S.md [deleted file]
docs/usecases/contiv/VPP_PACKET_TRACING_K8S.rst [new file with mode: 0644]
docs/usecases/contiv/Vagrant.md [deleted file]
docs/usecases/contiv/Vagrant.rst [new file with mode: 0644]
docs/usecases/contiv/index.rst
docs/usecases/hgw.md [deleted file]
docs/usecases/home_gateway.rst [new file with mode: 0644]
docs/usecases/ikev2/2_vpp.rst [new file with mode: 0644]
docs/usecases/ikev2/index.rst [moved from docs/usecases/ikev2.rst with 91% similarity]
docs/usecases/ikev2/vpp_init_sswan_resp.rst [new file with mode: 0644]
docs/usecases/ikev2/vpp_resp_sswan_init.rst [new file with mode: 0644]
docs/usecases/index.rst [deleted file]
docs/usecases/networksim.md [deleted file]
docs/usecases/networksim.rst [new file with mode: 0644]
docs/usecases/simpleperf/iperf3.rst
docs/usecases/simpleperf/iperf31.rst
docs/usecases/simpleperf/trex.rst
docs/usecases/simpleperf/trex1.rst
docs/usecases/simpleperf/trex2.rst
docs/usecases/trafficgen.md [deleted file]
docs/usecases/trafficgen.rst [new file with mode: 0644]
docs/usecases/vhost/index.rst
docs/usecases/vhost/vhost.rst
docs/usecases/vhost/vhost02.rst
docs/usecases/vhost/vhost03.rst
docs/usecases/vhost/vhost04.rst
docs/usecases/vhost/vhost05.rst
docs/usecases/vmxnet3.rst
docs/usecases/vpp_init_sswan_resp.md [deleted file]
docs/usecases/vpp_resp_sswan_init.md [deleted file]
docs/usecases/vppcloud/ConnectingVPC.rst [moved from docs/usecases/ConnectingVPC.rst with 100% similarity]
docs/usecases/vppcloud/automatingthedeployment.rst [moved from docs/usecases/automatingthedeployment.rst with 100% similarity]
docs/usecases/vppcloud/index.rst [moved from docs/usecases/vppcloud.rst with 92% similarity]
docs/usecases/vppcloud/vppinaws.rst [moved from docs/usecases/vppinaws.rst with 84% similarity]
docs/usecases/vppcloud/vppinazure.rst [moved from docs/usecases/vppinazure.rst with 60% similarity]
docs/usecases/webapp.md [deleted file]
docs/usecases/webapp.rst [new file with mode: 0644]
docs/whatisvpp/index.rst [deleted file]
doxygen/Makefile [deleted file]
doxygen/assets/doxy-vpp.css [deleted file]
doxygen/assets/logo_fdio.png [deleted file]
doxygen/dev_doc.md [deleted file]
doxygen/dir.dox.sample [deleted file]
doxygen/doxygen.cfg [deleted file]
doxygen/layout.xml [deleted file]
doxygen/siphon_templates/itemlist/default/item_format.itemlist [deleted file]
doxygen/siphon_templates/itemlist/default/item_header.itemlist [deleted file]
doxygen/siphon_templates/itemlist/syscfg/item_format.itemlist [deleted file]
doxygen/siphon_templates/markdown/clicmd/index_entry.md [deleted file]
doxygen/siphon_templates/markdown/clicmd/index_header.md [deleted file]
doxygen/test_framework_doc.md [deleted file]
doxygen/user_doc.md [deleted file]
src/scripts/fts.py
test/Makefile
test/doc/Makefile [deleted file]
test/doc/conf.py [deleted file]
test/doc/index.rst [deleted file]
test/doc/indices.rst [deleted file]
test/requirements-3.txt
test/requirements.txt