this repo has no description
dekker.one
1# README #
2
3This directory contains the MiniZinc documentation.
4
5### Building the docs ###
6
7You need the following tools to build the documentation:
8
9* Python 3
10* GNU make
11* Sphinx version 1.8.0. Install it using the command
12 `pip install git+https://github.com/sphinx-doc/sphinx`
13* Sphinx Read The Docs html theme. Install it using the command
14 `pip install sphinx_rtd_theme`
15* If you want to build the PDF documentation, you also need a LaTeX
16 distribution that includes xetex, and install the following fonts: Charter,
17 Lato and Inconsolata.
18
19To build the HTML documentation, simply run `make html`. To build the PDF, run `make latexpdf`.
20
21### Including the MiniZinc library reference documentation ###
22
23The reference documentation for the MiniZinc library can be generated
24automatically from the source code. Then run the following command:
25
26``mzn2doc --rst-output --include-stdlib --output-base en ../share/minizinc/std/globals.mzn``
27