Initial commit of Sphinx docs

Change-Id: I9fca8fb98502dffc2555f9de7f507b6f006e0e77
Signed-off-by: John DeNisco <jdenisco@cisco.com>
This commit is contained in:
John DeNisco
2018-07-26 12:45:10 -04:00
committed by Dave Barach
parent 1d65279ffe
commit 06dcd45ff8
239 changed files with 12736 additions and 56 deletions

2
.gitignore vendored
View File

@ -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

View File

@ -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/

View File

@ -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

Binary file not shown.

After

Width:  |  Height:  |  Size: 25 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 8.0 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 17 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 17 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 15 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 401 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 10 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 13 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 252 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 18 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 29 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 17 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 23 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 28 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 16 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 24 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 162 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.1 MiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 16 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 125 KiB

BIN
docs/_images/htmlBuild.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 260 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.1 MiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 318 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 168 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 740 KiB

BIN
docs/_images/rtdWebpage.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 516 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 73 KiB

Some files were not shown because too many files have changed in this diff Show More