summaryrefslogtreecommitdiffstats
path: root/docs/guides/api
diff options
context:
space:
mode:
authorJohn DeNisco <jdenisco@cisco.com>2018-07-26 12:45:10 -0400
committerDave Barach <openvpp@barachs.net>2018-07-26 18:34:47 +0000
commit06dcd45ff81e06bc8cf40ed487c0b2652d346a5a (patch)
tree71403f9d422c4e532b2871a66ab909bd6066b10b /docs/guides/api
parent1d65279ffecd0f540288187b94cb1a6b84a7a0c6 (diff)
Initial commit of Sphinx docs
Change-Id: I9fca8fb98502dffc2555f9de7f507b6f006e0e77 Signed-off-by: John DeNisco <jdenisco@cisco.com>
Diffstat (limited to 'docs/guides/api')
-rw-r--r--docs/guides/api/index.rst19
-rw-r--r--docs/guides/api/jvpp.rst46
2 files changed, 65 insertions, 0 deletions
diff --git a/docs/guides/api/index.rst b/docs/guides/api/index.rst
new file mode 100644
index 00000000000..d410d4a10cc
--- /dev/null
+++ b/docs/guides/api/index.rst
@@ -0,0 +1,19 @@
+.. _api:
+
+.. toctree::
+
+
+API User Guides
+===============
+
+This chapter describes how to use the C, Python and java APIs.
+
+.. _jvppjar:
+
+Downloading the jvpp jar
+------------------------
+The following are instructions on how to download the jvpp jar
+
+.. toctree::
+
+ jvpp
diff --git a/docs/guides/api/jvpp.rst b/docs/guides/api/jvpp.rst
new file mode 100644
index 00000000000..4c5c58256c2
--- /dev/null
+++ b/docs/guides/api/jvpp.rst
@@ -0,0 +1,46 @@
+.. _jvpp:
+
+.. toctree::
+
+Getting jvpp jar
+-------------------
+VPP provides java bindings which can be downloaded at:
+
+* https://nexus.fd.io/content/repositories/fd.io.release/io/fd/vpp/jvpp-core/18.01/jvpp-core-18.01.jar
+
+Getting jvpp via maven
+-------------------------
+
+**1. Add the following to the repositories section in your ~/.m2/settings.xml to pick up the fd.io maven repo:**
+
+.. code-block:: console
+
+ <repository>
+ <id>fd.io-release</id>
+ <name>fd.io-release</name>
+ <url>https://nexus.fd.io/content/repositories/fd.io.release/</url>
+ <releases>
+ <enabled>false</enabled>
+ </releases>
+ <snapshots>
+ <enabled>true</enabled>
+ </snapshots>
+ </repository>
+
+For more information on setting up maven repositories in settings.xml, please look at:
+
+* https://maven.apache.org/guides/mini/guide-multiple-repositories.html
+
+**2. Then you can get jvpp by putting in the dependencies section of your pom.xml file:**
+
+.. code-block:: console
+
+ <dependency>
+ <groupId>io.fd.vpp</groupId>
+ <artifactId>jvpp-core</artifactId>
+ <version>17.10</version>
+ </dependency>
+
+For more information on maven dependency managment, please look at:
+
+* https://maven.apache.org/guides/introduction/introduction-to-dependency-mechanism.html