Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 9 additions & 1 deletion .github/workflows/test.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
5 changes: 4 additions & 1 deletion docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -149,7 +149,10 @@

# Additional stuff for the LaTeX preamble.
#
# 'preamble': '',
'preamble': r'''
\usepackage{enumitem}
\setlistdepth{99}
''',

# Latex figure (float) alignment
#
Expand Down
11 changes: 9 additions & 2 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down