Initial commit of Sphinx docs
Change-Id: I9fca8fb98502dffc2555f9de7f507b6f006e0e77 Signed-off-by: John DeNisco <jdenisco@cisco.com>


2
.gitignore
vendored
@ -82,6 +82,8 @@ GTAGS
|
||||
/build-root/docs
|
||||
/build-root/.doxygen-bootstrap.ok
|
||||
/build-root/.doxygen-siphon.dep
|
||||
/docs/_build
|
||||
/env
|
||||
|
||||
# indent backup files
|
||||
*.BAK
|
||||
|
@ -28,6 +28,11 @@ Doxygen
|
||||
M: Chris Luke <chrisy@flirble.org>
|
||||
F: doxygen/
|
||||
|
||||
Sphinx Documents
|
||||
M: John DeNisco <jdenisco@cisco.com>
|
||||
M: Ray Kinsella <raykinsella78@gmail.com>
|
||||
F: docs/
|
||||
|
||||
DPDK Development Packaging
|
||||
M: Damjan Marion <damarion@cisco.com>
|
||||
F: dpdk/
|
||||
|
@ -1,56 +0,0 @@
|
||||
|
||||
Overview
|
||||
========
|
||||
|
||||
This repository was created as a private staring point for the vpp documentation
|
||||
project. It is expected that it will be used as a sandbox that can be used to
|
||||
evaluate and comment on the new fd.io document structure.
|
||||
|
||||
Build and Load Instructions
|
||||
===========================
|
||||
I build and load the documents using a mac, but these instuctions should be portable
|
||||
to any platform. I used the Python virtual environment.
|
||||
|
||||
For more information on how to use the Python virtual enviroment check out
|
||||
`Installing packages using pip and virtualenv`_.
|
||||
|
||||
.. _`Installing packages using pip and virtualenv`: https://packaging.python.org/guides/installing-using-pip-and-virtualenv/
|
||||
|
||||
1. Get the repository
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
git clone https://github.com/fdioDocs/vpp-docs
|
||||
cd vpp-docs
|
||||
|
||||
2. Install the virtual environment
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
python -m pip install --user virtualenv
|
||||
python -m virtualenv env
|
||||
source env/bin/activate
|
||||
pip install -r etc/requirements.txt
|
||||
|
||||
.. note::
|
||||
|
||||
To exit from the virtual environment execute:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
deactivate
|
||||
|
||||
3. Build the html files
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
cd docs
|
||||
make html
|
||||
|
||||
4. View the results.
|
||||
|
||||
To view the results start a browser and open the file:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
<THE CLONED DIRECTORY>/docs/_build/html/index.html
|
BIN
docs/_images/Connecting_two_vpp_instances_with_memif.png
Normal file
After Width: | Height: | Size: 25 KiB |
BIN
docs/_images/Create_Interface_Topology.jpg
Normal file
After Width: | Height: | Size: 8.0 KiB |
BIN
docs/_images/ForkButtons.png
Normal file
After Width: | Height: | Size: 17 KiB |
BIN
docs/_images/SNAT_Topology.jpg
Normal file
After Width: | Height: | Size: 17 KiB |
BIN
docs/_images/Switching_Topology.jpg
Normal file
After Width: | Height: | Size: 15 KiB |
BIN
docs/_images/VNET_Features.png
Normal file
After Width: | Height: | Size: 401 KiB |
BIN
docs/_images/VPP_App_as_a_vSwitch_x201.jpg
Normal file
After Width: | Height: | Size: 10 KiB |
After Width: | Height: | Size: 13 KiB |
BIN
docs/_images/VPP_Layering.png
Normal file
After Width: | Height: | Size: 252 KiB |
After Width: | Height: | Size: 18 KiB |
BIN
docs/_images/VPP_and_ovsdpdk_tested_on_haswellx86_platform.jpg
Normal file
After Width: | Height: | Size: 29 KiB |
After Width: | Height: | Size: 17 KiB |
After Width: | Height: | Size: 23 KiB |
After Width: | Height: | Size: 28 KiB |
BIN
docs/_images/VPP_sample_data_plane_management_agent_x260.jpg
Normal file
After Width: | Height: | Size: 16 KiB |
After Width: | Height: | Size: 24 KiB |
BIN
docs/_images/authreadthedocs.png
Normal file
After Width: | Height: | Size: 162 KiB |
BIN
docs/_images/buildVerRTD.png
Normal file
After Width: | Height: | Size: 1.1 MiB |
BIN
docs/_images/createNewPullReq.png
Normal file
After Width: | Height: | Size: 16 KiB |
BIN
docs/_images/examplePullReq.png
Normal file
After Width: | Height: | Size: 125 KiB |
BIN
docs/_images/htmlBuild.png
Normal file
After Width: | Height: | Size: 260 KiB |
BIN
docs/_images/importRTDManually.png
Normal file
After Width: | Height: | Size: 1.1 MiB |
BIN
docs/_images/importReadDocs.png
Normal file
After Width: | Height: | Size: 318 KiB |
BIN
docs/_images/issuePullReq.png
Normal file
After Width: | Height: | Size: 168 KiB |
BIN
docs/_images/passedBuild.png
Normal file
After Width: | Height: | Size: 740 KiB |
BIN
docs/_images/rtdWebpage.png
Normal file
After Width: | Height: | Size: 516 KiB |
BIN
docs/_images/showBothRemotes.png
Normal file
After Width: | Height: | Size: 73 KiB |