98f73cf1ed
Developer documentation is written in Markdown and can be built into HTML, PDF, etc. using Sphinx. Diagrams are written in PlantUML and rendered as SVGs. All developer docs live in the `developer-docs` folder under the root of the repository.
522 B
522 B
Building the Docs
In order to build the devloper documentation:
-
Install PlantUML. On macOS, this can be done via
brew install plantuml. -
Install the requirements for Sphinx:
$ pip install requirements.txt -
Run
maketo build the HTML documentation:$ make
This will regenerate any out-of-date SVGs and build the a local version of the HTML documentation. The documentation
can also be built from the repository root by running make developer_docs.