Cookiecutter Demo

Welcome to the main repository for the Cookiecutter Demo project.

TL;DR

Clone this repository somewhere with Anaconda Project and Conda installed, then run

make init

This will generate a Conda environment you can use to work with the project. Once this is done you can make the documentation, tests, etc. with commands like:

make test
make html
make doc-server
...

The latter will host the documentation on https://localhost:8000 and auto-update when you make changes.

These will use anaconda-project run to perform the various actions. If you want to manually interact with the environment, then you can run:

anaconda-project run shell

In this shell, you can directly run pytest for example.

Developer Notes

This file can be included in the documentation by adding the following to Docs/index.md:

```{include} ../README.md
```

See Docs/index.md for more details.