docs: Fix warning with sphinx build, add script to publish docs
[vpp.git] / docs / index.rst
1 .. fdio-vpp documentation master file, created by
2    sphinx-quickstart on Thu Apr 12 11:02:31 2018.
3    You can adapt this file completely to your liking, but it should at least
4    contain the root `toctree` directive.
5
6 #########
7 FD.io VPP
8 #########
9
10 FD.io Vector Packet Processing (VPP) is a fast, scalable layer 2-4
11 multi-platform network stack. VPP supports integration with OpenStack
12 and Kubernetes. Network management features include configuration,
13 counters and sampling. Development tools include plugin extensibility,
14 high-performance event-logging, multiple kinds of packet tracing;
15 debug images include extensive consistency checking.
16
17 Use-cases include vSwitch, vRouter, Gateways, Firewalls and Load
18 Balancers, to name several. Out of the box, VPP works as a software
19 development kit or an appliance.
20
21 .. toctree::
22    :maxdepth: 2
23
24    overview/index
25    gettingstarted/index
26    links/index
27    usecases/index
28    featuresbyrelease/index
29    troubleshooting/index
30    events/index
31    reference/index
32    relatedprojects/index
33    archive/index
34    about.rst