Skip to content

README.md

Latest commit

 

History

History
37 lines (24 loc) · 1.23 KB

README.md

File metadata and controls

37 lines (24 loc) · 1.23 KB

CI API docs

Reactor-C Documentation

Automatically Generated Doc Files

The code in reactor-c is documented with Javadoc-style comments that are automatically processed and deployed when you push updates to the repo. The latest docs can be found here:

Building Doc Files Locally

To build the doc files locally in your clone of the reactor-c repo, we use sphinx.

Prerequisites

  • Install python3, pip3 and doxygen
  • Install the required Python modules:
    • pip3 install sphinx
    • pip3 install sphinx_sitemap
    • pip3 install sphinx-rtd-theme
    • pip3 install breathe
    • pip3 install exhale

Build Documentation Files

  • Check out this repo and build the docs:
    • git clone git@github.com:lf-lang/reactor-c.git
    • cd reactor-c/docs
    • make html

View Documentation Files

  • Point your browser to the generated HTML page:
    • firefox _build/html/index.html