sanic/docs/contributing.md

26 lines
802 B
Markdown
Raw Normal View History

2016-10-14 12:51:08 +01:00
# How to contribute to Sanic
Thank you for your interest!
2016-10-14 12:51:08 +01:00
## Running tests
* `python -m pip install pytest`
* `python -m pytest tests`
## Documentation
Sanic's documentation is built using [sphinx](http://www.sphinx-doc.org/en/1.5.1/). 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:
```bash
rm -f docs/sanic.rst
rm -f docs/modules.rst
sphinx-apidoc -o docs/ sanic
sphinx-build -b html docs docs/_build
```
The HTML documentation will be created in the `docs/_build` folder.
2016-10-14 12:51:08 +01:00
## 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.