Documentation guide

Prerequisites

If you haven't already, clone and move into this repository:

git clone https://github.com/emnify/emnify-sdk-python.git
cd emnify-sdk-python

From the root, build the Docker container:

docker build . -f docs/Dockerfile.dev -t emnify/python-sdk-docs

# macOS and Linux
docker run -t -v $(pwd):/docs emnify/python-sdk-docs

# Windows
docker run -t -v %cd%:/docs emnify/python-sdk-docs

This command sets up (or updates) the build_sphinx project to run from inside the docs/ directory.

Once complete, you can preview the documentation as HTML pages in docs/build_sphinx.