Skip to content
mabroboticsPublic

About

Documentation for honey badger robots

Resources

Stars

0 stars

Watchers

0 watching

Forks

Repository files navigation

hb-docs

Documentation for Honey Badger robots.

Documentation structure

Building

Prepare build environment

sudo apt install python3-venv
python3 -m venv venv
. venv/bin/activate
pip install -r requirements.txt

Build the docs

jupyter-book build .

PDF of a released version

Before the docs move to a new software version, build the PDF of the current one and add it to downloads/ and the list in intro.md. Put the version in title in _config.yml first, then:

jupyter-book build --all --builder pdflatex .
gs -q -sDEVICE=pdfwrite -dPDFSETTINGS=/printer -dNOPAUSE -dBATCH -sOutputFile=downloads/hb-docs-v<version>.pdf _build/latex/book.pdf

Needs LaTeX (latexmk, xelatex) and Ghostscript. Revert the title change afterwards.

Pushing & Merging

Before every merge, do a typos check with:

typos

About

Documentation for honey badger robots

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors