-
Notifications
You must be signed in to change notification settings - Fork 7
Updating Documentation
Kiri Choi edited this page Sep 4, 2017
·
2 revisions
The details of libSBOL documentation can be updated through changing the contents of manual. The document settings can be configured through Doxyfile
.
It is possible to build documentation when compiling the library by setting SBOL_BUILD_MANUAL
in CMake, but one can also manually build documentation using Doxygen. To do so, simply go to the folder Doxyfile
is located at, and run:
doxygen
in command prompt/terminal. The output will be stored under _build
directory.
To update the document, changes must be pushed to gh-pages
branch. Simply copy over the new version of the document and commit/push the changes.