Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/sphinx-doc/sphinx.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorTormod Landet <tormod@landet.net>2017-03-16 11:35:11 +0300
committerTormod Landet <tormod@landet.net>2017-03-16 11:35:11 +0300
commitf6661fb0f30a754e6cbc8dd37615c6ba6f37a5d7 (patch)
tree4af60fc1dcea47a8a7358efaf9e3001bdf392d29 /CONTRIBUTING.rst
parentb7cada236f765003a73ab5dca48f975d54c0c298 (diff)
Mention style-checks and type-checks in devguide
Diffstat (limited to 'CONTRIBUTING.rst')
-rw-r--r--CONTRIBUTING.rst5
1 files changed, 5 insertions, 0 deletions
diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst
index d64f27702..30dee2774 100644
--- a/CONTRIBUTING.rst
+++ b/CONTRIBUTING.rst
@@ -127,6 +127,11 @@ These are the basic steps needed to start developing on Sphinx.
cd doc
make clean html latexpdf
+ * Run code style checks and type checks (type checks require mypy)::
+
+ make style-check
+ make type-check
+
* Run the unit tests under different Python environments using
:program:`tox`::