Skip to content

Commit

Permalink
Add intro how to build PDF and EBUP documentations
Browse files Browse the repository at this point in the history
  • Loading branch information
hagenw committed Mar 14, 2019
1 parent 795d819 commit b53442d
Showing 1 changed file with 17 additions and 0 deletions.
17 changes: 17 additions & 0 deletions CONTRIBUTING.rst
Original file line number Diff line number Diff line change
Expand Up @@ -40,11 +40,28 @@ To create the HTML pages, use::

The generated files will be available in the directory ``build/sphinx/html/``.

To create the EPUB file, use::

python3 setup.py build_sphinx -b epub

The generated EPUB file will be available in the directory
``build/sphinx/epub/``.

To create the PDF file, use::

python3 setup.py build_sphinx -b latex

Afterwards go to the folder ``build/sphinx/latex/`` and run LaTeX to create the
PDF file. If you don’t know how to create a PDF file from the LaTeX output, you
should have a look at Latexmk_ (see also this `Latexmk tutorial`_).

It is also possible to automatically check if all links are still valid::

python3 setup.py build_sphinx -b linkcheck

.. _Sphinx: http://sphinx-doc.org/
.. _Latexmk: http://personal.psu.edu/jcc8/software/latexmk-jcc/
.. _Latexmk tutorial: https://mg.readthedocs.io/latexmk.html

Running the Tests
^^^^^^^^^^^^^^^^^
Expand Down

0 comments on commit b53442d

Please sign in to comment.