Giters

castorini / howl

Wake word detection modeling toolkit for Firefox Voice, supporting open datasets like Speech Commands and Common Voice.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Document codebase and generate web docs with Sphinx

daemon opened this issue · comments

commented
  1. Document the codebase.
  2. Generate HTML documentation using Sphinx with the Napoleon and autodoc extensions.
  3. Write some tutorials and getting started guides.
  4. Create a GitHub page for Howl with the root directory set to docs/.

See https://flask.palletsprojects.com/en/1.1.x/ for a good Sphinx example.