diff options
Diffstat (limited to 'storage/maria/libmarias3/docs/contributors/docs.rst')
| -rw-r--r-- | storage/maria/libmarias3/docs/contributors/docs.rst | 45 |
1 files changed, 45 insertions, 0 deletions
diff --git a/storage/maria/libmarias3/docs/contributors/docs.rst b/storage/maria/libmarias3/docs/contributors/docs.rst new file mode 100644 index 00000000..47900a21 --- /dev/null +++ b/storage/maria/libmarias3/docs/contributors/docs.rst @@ -0,0 +1,45 @@ +Updating Documentation +====================== + +Overview +-------- + +This documentation is stored along with the source in the ``docs`` directory of the git tree and uses the `reStructuredText format <http://en.wikipedia.org/wiki/ReStructuredText>`_. + +We recommend reading this `reStructuredText Primer <http://sphinx-doc.org/rest.html>`_ before editing the docs for the first time. + +Compiling Docs +-------------- + +The docs are compiled using `Sphinx Python Documentation Generator <http://sphinx-doc.org/>`_. The libMariaS3 build system already knows how to use this. To compile the docs please follow theses steps: + +#. Install the ``python-sphinx`` package using your distribution's package manager + +#. Re-run bootstrap as follows so that it picks up that Sphinx is installed:: + + ./bootstrap.sh -m + +#. 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: + +#. Install ``python-sphinx`` as above + +#. Install the full *TeXLive* package. In Fedora this is ``texlive-scheme-full`` and ``texlive-full`` in Ubuntu + +#. Re-run bootstrap as follows so that it picks up that Sphinx and LaTeX are installed:: + + ./bootstrap.sh -m + +#. To compile in PDF format:: + + make latexpdf + +The generated PDF will be in the ``/docs/latex/`` directory. |