sanic/docs/contributing.md

How to contribute to Sanic

Thank you for your interest!

Running tests

• python -m pip install pytest
• python -m pytest tests

Documentation

Sanic's documentation is built using sphinx. Guides are written in Markdown and can be found in the docs folder, while the module reference is automatically generated using sphinx-apidoc.

To generate the documentation from scratch:

rm -f docs/_api/*
sphinx-apidoc -o docs/_api/ sanic
sphinx-build -b html docs docs/_build

The HTML documentation will be created in the docs/_build folder.

Warning

One of the main goals of Sanic is speed. Code that lowers the performance of Sanic without significant gains in usability, security, or features may not be merged.