This folder contains the source code for the MIPTools documentation. Our documentation can either be written in rst or MyST (a extension of markdown), both simple markup languages. We use the documentation tool, sphinx, to build our documentation, and host our final product on Github Pages.

Please feel free to contribute by submitting a pull request! To build and preview your changes, you may use the Makefile provided.

# Build html docs
make html

# Preview docs
open _build/html/index.html

You may also use sphinx autobuild to view changes live.

sphinx-autobuild . _build/html