Newer
Older
# MHCflurry documentation
To generate Sphinx documentation, from this directory run:
```
$ pip install -r requirements.txt # for the first time you generate docs
Documentation is written to the _build/ directory. These files should not be
checked into the repo.
We use the documentation system to generate the mhcflurry package level README.
To build this file, run:
```
$ make readme
```
This will write `docs/package_readme/readme.generated.rst`. The main
[README.rst](../README.rst) is symlinked to this file.