This repo contains:
/epiphancloud
: Python wrapper for Epiphan Cloud API/docs
: API reference/examples/full_lifecycle.py
: Usage example
$ git clone https://github.com/epiphan-video/epiphancloud_api.git
$ cd epiphancloud_api
$ pip install -r requirements.txt
API documentation is available via Github Pages: https://epiphan-video.github.io/epiphancloud_api
Documentation source is stored in docs-source-slate
folder.
- Build a slate builder container (once):
$ cd slate
$ docker build -t slate-builder .
- (optional) Start doc server:
docker run -it --rm \
-v $(pwd)/docs-source-slate/:/slate/source \
-v $(pwd)/docs:/slate/build \
-p 4567:4567 \
slate-builder bundle exec middleman server
...and open http://localhost:4567/ in your browser.
- When editing is done, use the container to build static docs:
docker run -it --rm -v $(pwd)/docs-source-slate/:/slate/source -v $(pwd)/docs:/slate/build slate-builder
This command will update files in docs
folder, if necessary.
- git commit and push
jupyter nbconvert --to html --execute device_api.ipynb --ExecutePreprocessor.timeout=-1