README.md

Building the Documentation for PowerModels.jl

Installation

We rely on Documenter.jl. To install it, run the following command in a julia session:

Pkg.add("Documenter")

Building the Docs

To preview the html output of the documents, run the following command:

julia --color=yes make.jl

You can then view the documents in build/index.html.

Warning: Do not git commit the contents of build (or any other content generated by Documenter) to your repository's master branch. This helps to avoid including unnessesary changes for anyone reviewing commits that happen to include documentation changes.

For further details, please read the documentation for Documenter.jl.