Contributing

Code and issues

The code is on github: https://github.com/adshares/adselect

Please submit issues there.

Installation for development

Please see deploy for detailed instructions.

Documentation

All documentation dependencies are installed together with development dependencies.

The documentation can be build using Sphinx with the following extensions:

• sphinx-rtd-theme (html theme)
• sphinxcontrib-httpdomain (api documentation)
• sphinx-jsondomain (fork by boolangery) (api/json objects documentation)

Building documentation

pipenv run build_docs

When documenting the API, you should first update the JSON objects in adselect.iface.proto. You can then use Sphinx generated documentation to paste response examples into API methods documentation.

Tests

Please see testing for detailed instructions.