API Doc Generation

The following contains instructions on how to generate the Scala and Python docs for Xskipper.

Xskipper Python Docs

Xskipper Python docs are generated using Sphinx

Installation

pip install -U Sphinx
pip install mock

Local Changes

The doc configs are located in python/doc.

Make the needed changes to the python files and then create the HTML files using:

cd python/doc
make html

The results will be located under _build/html

Note

By default the version that will be used is the version that is written inversion.sbt If you would like to change the version change it in the config file conf.py

Publishing

To update the docs copy _build/html to site/docs/api/pythondoc/<version_number>.
For example (assuming you shell is pointed at the project root):

cp -r python/doc/_build/html site/docs/api/pythondoc/1.3.0

Then update the index file to point to the new API documentation.

Xskipper Scala Docs

Xskipper Scala docs are generated using sbt doc

Generate the docs

Run the following:

sbt clean compile package
sbt doc

Publishing

To update the docs copy target/scala-2.12/api/ to ../scaladoc/1.3.0/.
For example (assuming you shell is pointed at the project root):

cp -r target/scala-2.12/api/ site/docs/api/scaladoc/1.3.0/

Then update the index file to point to the new API documentation.