Skip to content
Snippets Groups Projects
README.md 458 B
Newer Older
# MHCflurry documentation

To generate Sphinx documentation, from this directory run:

```
Tim O'Donnell's avatar
Tim O'Donnell committed
$ pip install -r requirements.txt  # for the first time you generate docs
$ make rst html
```

Tim O'Donnell's avatar
Tim O'Donnell committed
The above command will also regenerate `docs/readme.generated.md`. The main
[README.md](../README.md) is symlinked to this file.

Tim O'Donnell's avatar
Tim O'Donnell committed
Files in this directory that start with an "_" are also generated by
the command given above. These files should not be checked into the repo.