Documentation Generation Instructions¶
Note: Before proceeding, please build Drake from source. This is necessary because otherwise the various build targets mentioned below will not exist.
Drake’s documentation is built using the
documentation build target.
After building Drake like normal, execute:
$ cd drake-distro/build/drake $ [make|ninja] documentation
To view the generated documentation, open the following files using a web browser:
- Drake website:
- Doxygen C++ website:
- Doxygen Matlab website:
If you’re using
ninja, there are two additional build targets that allow you
to build just the Sphinx website or C++ Doxygen website:
$ cd drake-distro/build/drake $ ninja doc/doxygen_cxx_output $ ninja doc/sphinx_output