-
Notifications
You must be signed in to change notification settings - Fork 8
build api documentation
Connor Gäde edited this page Sep 25, 2020
·
2 revisions
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.bashTo build the API documentation change to the "api-doc" folder and run (depending on what documentation you want to build):
make htmlThe resulting documentation can be found at the api-doc/_build folder.