diff options
| author | Richard van der Hoff <github@rvanderhoff.org.uk> | 2016-07-01 09:36:51 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2016-07-01 09:36:51 +0100 |
| commit | 1238203bc47166d1d4ca686e108e84add3bf98b4 (patch) | |
| tree | f50cac69546ebf1d84c8f8a4ade114a754bb6161 /docs | |
| parent | code_style.rst: *fix* link to google style (diff) | |
| download | synapse-1238203bc47166d1d4ca686e108e84add3bf98b4.tar.xz | |
code_style.rst: add link to sphinx examples
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/code_style.rst | 4 |
1 files changed, 3 insertions, 1 deletions
diff --git a/docs/code_style.rst b/docs/code_style.rst index 39710ab4ae..8d73d17beb 100644 --- a/docs/code_style.rst +++ b/docs/code_style.rst @@ -45,6 +45,8 @@ Basically, PEP8 Comments should follow the `google code style <http://google.github.io/styleguide/pyguide.html?showone=Comments#Comments>`_. This is so that we can generate documentation with -`sphinx <http://sphinxcontrib-napoleon.readthedocs.org/en/latest/>`_. +`sphinx <http://sphinxcontrib-napoleon.readthedocs.org/en/latest/>`_. See the +`examples <http://sphinxcontrib-napoleon.readthedocs.io/en/latest/example_google.html>`_ +in the sphinx documentation. Code should pass pep8 --max-line-length=100 without any warnings. |