# imgaug-doc

**Repository Path**: wbr_git/imgaug-doc

## Basic Information

- **Project Name**: imgaug-doc
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2022-02-14
- **Last Updated**: 2022-02-14

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# imgaug-doc

This repository contains code and assets to generate the documentation of [imgaug](https://github.com/aleju/imgaug).
The files were moved to their own repository (instead of a folder inside `imgaug`)
as they were starting to become too large -- especially the images.

To generate the docs, first install the necessary packages, e.g. via:
```bash
pip install Sphinx numpydoc sphinx_rtd_theme
```

Then generate the documentation via
```bash
make html
```

When calling `make html`, the content of this repository (`imgaug-doc`) must be a folder
inside the main repository (`imgaug`), i.e. something like `imgaug/doc` where `doc`
contains this repository's content.

Note that when calling `make html` you will probably get lots of warnings saying
`WARNING: toctree contains reference to nonexisting document (...)`. That is normal.
Just ignore these messages.