Documentation¶

Documentation at https://privly-safari.readthedocs.org

https://travis-ci.org/sammyshj/privly-safari.svg?branch=master

https://coveralls.io/repos/sammyshj/privly-safari/badge.png

Build¶

In the current directory, run make html to build the Sphinx documentation locally.

To build the html files for the javascript files in the extension, clone the repo https://github.com/sammyshj/privly-jsdoc-toolkit

Copy the javascript files to the src directory of the cloned repo. Then, run, java -jar jsrun.jar app/run.js -t=templates/jsdoc src/*.* inside the cloned repo directory.

The html files generated will be inside the out directory. Copy the html files to the current directory and run make html again to see the changes.