From 01d6d8d5bba27c58254f958566e75979fd71ea15 Mon Sep 17 00:00:00 2001 From: Viktor Kuncak <viktor.kuncak@epfl.ch> Date: Fri, 8 May 2015 00:49:10 +0200 Subject: [PATCH] Explained how to build documentation using sphinx --- doc/installation.rst | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/doc/installation.rst b/doc/installation.rst index 278a696fc..2b33e83a9 100644 --- a/doc/installation.rst +++ b/doc/installation.rst @@ -90,3 +90,19 @@ their binaries available in the ``$PATH``. Since the default solver uses the native Z3 API, you will have to explicitly specify another solver if this native layer is not available to you. Check also the the ``--solvers`` in :ref:`cmdlineoptions` . + +Building Documentation +---------------------- + +To build this documentation locally, you will need Sphinx ( +http://sphinx-doc.org/ ), a restructured text toolkit that +was originally build to support Python documentation. You will +also need `make`. + +After installing sphinx, entering the `doc/` directory of +Leon and running `make html` should build the documentation +in the HTML format. (Several other formats are supported, +though we do not use them, so we do not vouch for the +quality of the output.) As a top-level file for the HTML +documentation check `doc/_build/html/index.html` (you may +wish to bookmark this file in your browser). -- GitLab