Documentation

Overview

Documentation is generated automatically via Doxygen by parsing documentation from the source code. This means that, in order for Doxygen to be useful, you should perform your due diligence in ensuring that all newly added code is both documented appropriately, and in the proper format. Code reviewers will enforce this.

Publication Automation

All newly merged pull requests will automatically build and publish documentation to the RDFS documentation portal. Thus, this page is updated automatically with every new commit into develop.

Manual Generation

If you wish to generate docs yourself locally, follow these instructions.

1. Install Doxygen, following these instructions.
2. Generate docs in the repo root: $ doxygen
3. The generated HTML is in html/. Run html/index.html to see the home page.