Updating Documentation

Overview

This documentation is stored along with the source in the docs directory of the git tree and uses the reStructuredText format.

We recommend reading this reStructuredText Primer before editing the docs for the first time.

Compiling Docs

The docs are compiled using Sphinx Python Documentation Generator. The libMariaS3 build system already knows how to use this. To compile the docs please follow theses steps:

1. Install the python-sphinx package using your distribution’s package manager

2. Re-run bootstrap as follows so that it picks up that Sphinx is installed:

   ./bootstrap.sh -m
   

3. To compile in HTML format:

   make html
   

There will now be an HTML version of the docs in the /html directory of the source.

Compiling PDF Docs

Sphinx required LaTeX to build PDF docs. The following steps show you how to build PDF docs:

1. Install python-sphinx as above

2. Install the full TeXLive package. In Fedora this is texlive-scheme-full and texlive-full in Ubuntu

3. Re-run bootstrap as follows so that it picks up that Sphinx and LaTeX are installed:

   ./bootstrap.sh -m
   

4. To compile in PDF format:

   make latexpdf
   

The generated PDF will be in the /docs/latex/ directory.