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
Simply make html
in this directory.
Use sphinx-apidoc to automatically generate a new .rst
file:
cd docs/
sphinx-apidoc -o . ../path/to/new/python/module
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 .