Skip to content

Updating the Documentation

Kiri Choi edited this page Sep 14, 2019 · 3 revisions

Documentation should always be provided for any changes to the libRoadRunner C++ sources via Doxygen tags. For changes to language bindings, the language's respective documentation system should be used. For example, changes to libRoadRunner's Python API should include changes to the Sphinx documentation in wrappers/Python/docs.

To update the Python documentation, one should modify the content of https://github.com/sys-bio/roadrunner/tree/develop/wrappers/Python/doc accordingly. Python libRoadRunner documentation is based on readthedocs, so once the change is committed and pushed, the documentation should update automatically.

Keep in mind that the Python documentation is currently tracking the develop branch.