Skip to content

Files

Latest commit

Jun 13, 2023
a95a746 · Jun 13, 2023

History

History
This branch is up to date with intuitive-robots/irl_polymetis:main.

docs

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
Jun 13, 2023
Jun 13, 2023
Jun 13, 2023
Jun 13, 2023
Jun 13, 2023

Documentation

Modify code in source to change documentation. They will be published at Github Pages when merged to main.

You can start a webserver in _build/html to see local changes: python -m http.server

Auto-generated documentation

Generating Python documentation

Simply make html in this directory.

Adding a new module

Use sphinx-apidoc to automatically generate a new .rst file:

cd docs/
sphinx-apidoc -o . ../path/to/new/python/module

Generating C++ documentation

While building locally, simply add the BUILD_DOCS flag to your cmake command:

mdkir -p ./polymetis/build/
cd ./polymetis/build/

cmake .. -DBUILD_DOCS=ON
cmake --build .