diff options
| author | Paul Kehrer <paul.l.kehrer@gmail.com> | 2014-06-05 12:40:56 -0500 |
|---|---|---|
| committer | Paul Kehrer <paul.l.kehrer@gmail.com> | 2014-06-05 12:40:56 -0500 |
| commit | 813b294031ab365073d475f5d11e866114726e69 (patch) | |
| tree | d9b70be4f96976b1f21d1a9d71b387bad5bd1bdb | |
| parent | e5f7e3055ee28c420eda563aafad19d664a6a76c (diff) | |
| download | cryptography-813b294031ab365073d475f5d11e866114726e69.tar.gz cryptography-813b294031ab365073d475f5d11e866114726e69.tar.bz2 cryptography-813b294031ab365073d475f5d11e866114726e69.zip | |
add information about building docs to getting started
| -rw-r--r-- | docs/development/submitting-patches.rst | 4 |
1 files changed, 3 insertions, 1 deletions
diff --git a/docs/development/submitting-patches.rst b/docs/development/submitting-patches.rst index f1bf954b..b7f43283 100644 --- a/docs/development/submitting-patches.rst +++ b/docs/development/submitting-patches.rst @@ -153,7 +153,8 @@ details. Documentation ------------- -All features should be documented with prose in the ``docs`` section. +All features should be documented with prose in the ``docs`` section. To ensure +it builds and passes `doc8`_ style checks you can run ``tox -e docs``. Because of the inherent challenges in implementing correct cryptographic systems, we want to make our documentation point people in the right directions @@ -201,3 +202,4 @@ So, specifically: .. _`syntax`: http://sphinx-doc.org/domains.html#info-field-lists .. _`Studies have shown`: http://www.ibm.com/developerworks/rational/library/11-proven-practices-for-peer-review/ .. _`our mailing list`: https://mail.python.org/mailman/listinfo/cryptography-dev +.. _`doc8`: https://github.com/stackforge/doc8 |