Skip to content

Latest commit

 

History

History

docs

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 
 
 

Updating the documentation

First, if you haven't already, run:

cd ~/ParlAI; python setup.py develop

Then use make to build the html:

make html

NOTE: Autodocs imports many agents, so you may run into ImportErrors when running make. Just pip install as needed to continue.

Then, make any changes to the documentation in source, do make html again, and check your changes by checking the html files in build/html (you can start by opening index.html). If everything looks good, make a Pull Request and the documentation will update automatically once the change has landed. If the documentation is not up to date within an hour after landing, please file an issue.