Skip to content
Snippets Groups Projects
README.md 396 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
Tim O'Donnell's avatar
Tim O'Donnell committed
$ make generate html
Tim O'Donnell's avatar
Tim O'Donnell committed
Documentation is written to the _build/ directory. These files should not be
checked into the repo.
Tim O'Donnell's avatar
Tim O'Donnell committed

To test example code:
```
$ make doctest 
```

Then take a look at _build/doctest for detailed output.