Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 10 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,9 +35,18 @@ pip install emnify-sdk

Read more about working with the Python SDK and the underlying concepts in the [emnify product documentation](https://docs.emnify.com/sdks/python).

### API reference

We use [sphinx-autoapi](https://github.com/readthedocs/sphinx-autoapi) to auto-generate the API reference documentation within this repository.
This documentation is hosted separately on [GitHub Pages](https://emnify.github.io/emnify-sdk-python/autoapi/index.html).

> 🗺️ _Note: We plan to eventually migrate the API reference documentation into our [product documentation platform](https://docs.emnify.com/)._

See our [documentation guide](./docs/README.md) if you're interested in contributing to the API reference or running the documentation locally.

## Contributing

If you've found a bug or would like to add new features, [open an issue](https://github.com/emnify/emnify-sdk-python/issues/new) or [create a pull request](https://github.com/emnify/emnify-sdk-python/pulls) to this Github repository.
If you've found a bug or want to add new features, [open an issue](https://github.com/emnify/emnify-sdk-python/issues/new) or [create a pull request](https://github.com/emnify/emnify-sdk-python/pulls) to this GitHub repository.

See our [development guide](./DEVELOPMENT.md) for how to get started.

Expand Down
39 changes: 33 additions & 6 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,36 @@
### Generate Documentation Locally
# Documentation guide

1) Build a container
## Prerequisites

`docker build . -f docs/Dockerfile.dev -t emnify/python-sdk-docs`
- [Docker](https://www.docker.com/)

2) Run docgen
1) mac/linux `docker run -t -v $(pwd):/docs emnify/python-sdk-docs`
2) for windows `docker run -t -v %cd%:/docs emnify/python-sdk-docs`
## Running the documentation locally

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

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

From the root, build the Docker container:

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

2. Run docgen

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

```shell
# 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`.