docs/ contains end user documentation geared towards writing smart contracts with PyTeal. The README explains how to edit docs.
Pyteal uses Sphinx to generate HTML from RST files. Test changes by generating HTML and viewing with a web browser.
Here's the process:
- Perform one-time environment setup:
- Activate the top-level virtual environment.
- Install dependencies:
pip install -r requirements.txt.
- Generate HTML docs:
make html. - If successful, generated HTML is available in
docs/_build/html.
Additionally, each PR commit generates HTML docs via Github Actions.
Production docs live at https://pyteal.readthedocs.io/en/stable/.