https://github.com/digital-dream-labs/oskr-owners-manual

Comprehensive reference manual for OSKR-enabled Vector robots
https://github.com/digital-dream-labs/oskr-owners-manual

Last synced: 30 days ago
JSON representation

Comprehensive reference manual for OSKR-enabled Vector robots

• Host: GitHub
• URL: https://github.com/digital-dream-labs/oskr-owners-manual
• Owner: digital-dream-labs
• License: other
• Created: 2020-09-30T14:53:20.000Z (about 4 years ago)
• Default Branch: master
• Last Pushed: 2023-04-30T23:24:42.000Z (over 1 year ago)
• Last Synced: 2024-08-04T01:27:10.429Z (4 months ago)
• Language: Python
• Size: 8.32 MB
• Stars: 37
• Watchers: 9
• Forks: 27
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# OSKR Owner's Manual

The OSKR Owner's Manual is generated via the [Sphinx Documentation

Generator](https://www.sphinx-doc.org/en/master/index.html).

Most people will want to view the documents directly online at:

* [HTML](https://oskr.ddl.io/)

* PDF

This repository is only of use if you wish to modify the document,

create additional content, etc.

Docs can be viewed online by clicking on the [doc

directory](./doc), viewed on your local machine, or

built out in to pretty html or pdf documents.  These built out files

will be placed within a [_build] directory.

To install:

    virtualenv -p python3 ./oom

    source ./oom/bin/activate

    pip install -r requirements.txt

To build locally:

    source ./bin/activate # if virtualenv hasn't been activated yet

    make html

or, to make a single large html file:

    make singlehtml

To generate PDFs on OSX:

    brew cask install mactex-no-gui # one time install

    make latexpdf

To read locally in your browser:

    open _build/html/index.html

To read the pdf locally:

    open _build/latex/oom.pdf