From a9243276cc888976042516bea5dc8be86af71ba7 Mon Sep 17 00:00:00 2001 From: Tormod Landet Date: Thu, 16 Mar 2017 09:35:11 +0100 Subject: Mention style-checks and type-checks in devguide --- CONTRIBUTING.rst | 5 +++++ 1 file changed, 5 insertions(+) (limited to 'CONTRIBUTING.rst') 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`:: -- cgit v1.2.3 From 2b929dc27eec7724d8a19b818fea81cca5b6c9ee Mon Sep 17 00:00:00 2001 From: jfbu Date: Sat, 18 Mar 2017 09:25:48 +0100 Subject: Fix syntax coloring in CONTRIBUTING.rst --- CONTRIBUTING.rst | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) (limited to 'CONTRIBUTING.rst') diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index 30dee2774..3ea46f674 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -1,3 +1,5 @@ +.. highlight:: console + Sphinx Developer's Guide ======================== @@ -127,10 +129,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):: + * Run code style checks and type checks (type checks require ``mypy`` and are + currently done for commits to ``master`` only):: - make style-check - make type-check + make style-check + make type-check * Run the unit tests under different Python environments using :program:`tox`:: @@ -279,9 +282,7 @@ Debugging Tips `modified snowballcode generator `_. Generated `JSX `_ files are in `this repository `_. - You can get the resulting JavaScript files using the following command: - - .. code-block:: bash + You can get the resulting JavaScript files using the following command:: $ npm install $ node_modules/.bin/grunt build # -> dest/*.global.js -- cgit v1.2.3 From ada9aa6b9432517bdf042832eba1bf6b4d66ad32 Mon Sep 17 00:00:00 2001 From: jfbu Date: Sat, 18 Mar 2017 09:45:19 +0100 Subject: Markup in CONTRIBUTING.rst --- CONTRIBUTING.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'CONTRIBUTING.rst') diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index 3ea46f674..e3a68b58e 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -277,7 +277,7 @@ Debugging Tips * Set the debugging options in the `Docutils configuration file `_. -* JavaScript stemming algorithms in `sphinx/search/*.py` (except `en.py`) are +* JavaScript stemming algorithms in ``sphinx/search/*.py`` (except ``en.py``) are generated by this `modified snowballcode generator `_. Generated `JSX `_ files are -- cgit v1.2.3