Skip to content

mangdangroboticsclub/MiniPupperDocs

Repository files navigation

Mini Pupper - ROS, OpenCV, Open-source, Pi Robot Dog

Mini Pupper will make robotics easier for schools, homeschool families, enthusiasts and beyond.

「Mini Pupperは、学校、家庭学習、愛好家、そしてそれ以外の人々にも、ロボット工学をより身近なものにしてくれることでしょう」 by MangDang

Sphinx Document Buildling

This document is written in reStructuredText, designed following Sphinx practice, and hosted on Read the Docs and GitHub Pages.

This document can also be built locally, where the following environment setup would be initially required:

# Setup Poetry (Python package and project manager)
pip install poetry
# Install the Python packages
poetry install
# Activate virtual env
poetry shell

Then the following commands can build a result of HTML documents to view in browsers directly:

cd ./docs
make rtd
# The details of rtd-ja refers to _Sphinx Document Internationalization_ below.
# make rtd-ja

Now the build result files can be opened from docs/_build/html.

Sphinx Document Internationalization

# Make Sphinx-generated messages (Japanese version is prebuilt here)
make intl-ja

# Preview Sphinx-generated messages as HTML
make rtd-ja

Releases

No releases published

Packages

No packages published

Contributors 14