Skip to content

build api documentation

Connor Gäde edited this page Sep 25, 2020 · 2 revisions

Build API documentation

The api documentation is generated with Sphinx. It automatically generates class documentations from the source code. This requires all packages to be installed (see Installation). Make sure to source the api and pyrep variables so sphinx is able to import everything:

   source api/activate.bash
   source api/pyrep_env.bash

Standard HTML documentation

To build the API documentation change to the "api-doc" folder and run (depending on what documentation you want to build):

make html

The resulting documentation can be found at the api-doc/_build folder.

Clone this wiki locally