https://github.com/kumarrobotics/kr_docs
Repository for documentation relevant to the KumarRobotics organization
https://github.com/kumarrobotics/kr_docs
Last synced: 3 months ago
JSON representation
Repository for documentation relevant to the KumarRobotics organization
- Host: GitHub
- URL: https://github.com/kumarrobotics/kr_docs
- Owner: KumarRobotics
- Created: 2014-06-23T20:36:57.000Z (almost 11 years ago)
- Default Branch: master
- Last Pushed: 2021-10-17T12:10:35.000Z (over 3 years ago)
- Last Synced: 2025-01-04T16:33:40.777Z (5 months ago)
- Size: 1.15 MB
- Stars: 2
- Watchers: 51
- Forks: 6
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Introducing kr_docs
This repo is a collection of general documentation to consider when contributing to the KumarRobotics organization.
Click the following link to read the docs.
### [Kumar Robotics Github Documentation](http://kumar-robotics-github-documentation.readthedocs.org/en/master/)
## How to contribute
Contributing to `kr_docs` is easy.
If you are using Ubuntu, simply do:
```
sudo apt-get install python-sphinx python-sphinx-rtd-theme python-recommonmark
git clone https://github.com/KumarRobotics/kr_docs.git
cd kr_docs/docs
make html
xdg-open build/html/index.html
```
If build fails, install latest packages from pip
```
sudo apt install python-pip
sudo pip install sphinx sphinx-rtd-theme recommonmark
```
If you are using OSX and already have [Homebrew](http://brew.sh), simpliy do
```
brew install sphinx
sudo pip install sphinx_rtd_theme recommonmark
git clone https://github.com/KumarRobotics/kr_docs.git
cd kr_docs/docs
make html
open build/html/index.html
```
You will see your latest changes locally.