Merge pull request #622 from iory/ga-docs

Add PDF build test to documentation workflow

Author: iory

.github/workflows/test.yml

@@ -55,11 +55,19 @@ jobs:
       run: |
         python -m pip install --upgrade pip
         pip install --no-cache-dir .\[all\]
-    - name: Build Sphinx Documentation
+    - name: Build Sphinx Documentation (HTML)
       working-directory: ./docs/source
       run: |
         mkdir -p _build/doctrees
         sphinx-build -T -W --keep-going -b html -d _build/doctrees -D language=en . _build/html
+    - name: Install LaTeX dependencies
+      run: |
+        sudo apt-get update -qq -y
+        sudo apt-get install -qq -y texlive-latex-recommended texlive-latex-extra texlive-fonts-recommended latexmk
+    - name: Build Sphinx Documentation (PDF)
+      working-directory: ./docs
+      run: |
+        make latexpdf
 
   requirements-formatting:
     name: Check Requirements Formatting

docs/source/conf.py

@@ -149,7 +149,10 @@
 
     # Additional stuff for the LaTeX preamble.
     #
-    # 'preamble': '',
+    'preamble': r'''
+\usepackage{enumitem}
+\setlistdepth{99}
+''',
 
     # Latex figure (float) alignment
     #

docs/source/index.rst

@@ -6,8 +6,15 @@ Scikit-Robot is a simple pure-Python library for loading, manipulating, and visu
 URDF files and robot specifications. For example, here's a rendering of a PR2
 robot moving after being loaded by this library.
 
-.. image:: ../image/pr2.gif
-   :align: center
+.. only:: html
+
+   .. image:: ../image/pr2.gif
+      :align: center
+
+.. only:: latex
+
+   .. image:: ../image/pr2.png
+      :align: center
 
 .. toctree::
    :maxdepth: 2