README.md

Documentation

Modify code in source to change documentation.

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

To update the documentation hosted at Github Pages, you can update the repository.

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 .