Skip to content

Latest commit

 

History

History
25 lines (16 loc) · 598 Bytes

README.md

File metadata and controls

25 lines (16 loc) · 598 Bytes
Raw

ESPnet document generation

Install

We use travis-sphinx to generate & deploy HTML documentation.

$ cd <espnet_root>
$ pip install -e ".[doc]"

Generate HTML

You can generate local HTML manually using sphinx Makefile

$ cd <espnet_root>
$ ./ci/doc.sh

open doc/build/html/index.html

Deploy

When your PR is merged into master branch, our Travis-CI will automatically deploy your sphinx html into https://espnet.github.io/espnet/ by travis-sphinx deploy.