An open API service indexing awesome lists of open source software.

https://github.com/bebo/bebo-sdk-docs


https://github.com/bebo/bebo-sdk-docs

Last synced: 11 days ago
JSON representation

Awesome Lists containing this project

README

        

# bebo-sdk-docs

Hosted at http://bebo-sdk.readthedocs.io

To setup:

1. Clone repo
2. `$ cd bebo-sdk-docs`
3. `$ virtualenv env` to make a Python virtual environment (`pip install virtualenv` if you don't have this command)
4. `$ source env/bin/activate` to activate your virtual environment
5. `$ pip install -r requirements.txt` to install required packages

To edit locally:

1. `$ cd docs`
1. Create/edit any .rst file
2. `$ make html` inside docs to build new HTML files
3. Open newly-built docs/_build/html/ file in a browser

To publish to RTD:

1. Simply commit and RTD will auto-build