Skip to content

Files

Latest commit

709b6c2 · Oct 28, 2019

History

History

docs

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
Oct 28, 2019
Aug 21, 2019
Aug 21, 2019
Aug 21, 2019
Aug 21, 2019
Aug 21, 2019

Build Documentation:

Install Requirements

pip install -r requirements.txt

Build Documentation

# Enter docs folder.
cd docs
# Use sphinx autodoc to generate rst.
sphinx-apidoc -o source/ ../matchzoo/
# Generate html from rst
make clean
make html

This will install all the packages need in the code. This can cause some error issue That is not necessary.

So , we have a new way to generate documents
Follow this link

pip install sphinx-autoapi

then modify the conf.py

extensions = ['autoapi.extension']
autoapi_dirs = ['../mypackage']

then

make html