2.5 KiB
Buildhosts
This article needs some work
If you have any contribution send us your PR <../pulls>
, see how to contribute
.
To get best results from build, its recommend to install additional packages on build hosts.
Build docs
Sphinx build needs
Most of the sphinx requirements are installed from setup.py
and the docs can be build from scratch with make docs
. For better math and image processing additional packages are needed. The XeTeX needed not only for PDF creation, its also needed for math
when HTML output is build.
To be able to do sphinx:math-support
without CDNs, the math are rendered as images (sphinx.ext.imgmath
extension). If your docs build (make docs
) shows warnings like this:
WARNING: dot(1) not found, for better output quality install \
graphviz from http://www.graphviz.org
..
WARNING: LaTeX command 'latex' cannot be run (needed for math \
display), check the imgmath_latex setting
you need to install additional packages on your build host, to get better HTML output.
Ubuntu / debian
sudo apt install graphviz imagemagick texlive-xetex librsvg2-bin $
Arch Linux
sudo pacman -S graphviz imagemagick texlive-bin extra/librsvg $
Fedora / RHEL
sudo dnf install graphviz graphviz-gd texlive-xetex-bin librsvg2-tools $
For PDF output you also need:
Ubuntu / debian
sudo apt texlive-latex-recommended texlive-extra-utils ttf-dejavu $
Arch Linux
sudo pacman -S texlive-core texlive-latexextra ttf-dejavu $
Fedora / RHEL
sudo dnf install \
$ texlive-collection-fontsrecommended texlive-collection-latex \
dejavu-sans-fonts dejavu-serif-fonts dejavu-sans-mono-fonts
../conf.py