Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit 7d37128

Browse files
committed
Doc: set highlight parser to use when needed
1 parent 775f19d commit 7d37128

File tree

3 files changed

+26
-19
lines changed

3 files changed

+26
-19
lines changed

docs/source/developers.rst

Lines changed: 19 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
.. highlight:: console
2+
13
==========
24
Developers
35
==========
@@ -7,35 +9,39 @@ Setup
79

810
1. You need to fork the `GitHub repository <https://github.com/BoboTiG/python-mss>`_.
911

10-
**Note :** always work on a **specific branch**, based on the *dev* one, dedicated to your patch.
12+
.. Note::
13+
14+
Always work on a **specific branch**, based on the *dev* one, dedicated to your patch.
1115

1216
2. Be sure to add/update tests and documentation within your patch.
1317

1418

1519
Testing
1620
=======
1721

18-
As he module is Python 2 and 3 compliant, do no forgot to test for both. If you cannot, just say it when sending the patch, someone else will validate for you.
22+
.. Note::
23+
24+
As he module is Python 2 and 3 compliant, do no forgot to test for both. If you cannot, just say it when sending the patch, someone else will validate for you.
1925

2026

2127
Dependency
2228
----------
2329

2430
You will need `pytest <https://pypi.python.org/pypi/pytest>`_::
2531

26-
pip install pytest
32+
$ pip install pytest
2733

2834

2935
How to test?
3036
------------
3137

3238
Enable the developer mode::
3339

34-
sudo python setup.py develop
40+
$ sudo python setup.py develop
3541

3642
Lauch the test suit::
3743

38-
py.test
44+
$ py.test
3945

4046

4147
Validating the code
@@ -49,16 +55,16 @@ Dependencies
4955

5056
Install required packages::
5157

52-
pip install flake8 pylint
58+
$ pip install flake8 pylint
5359

5460

5561
How to validate?
5662
----------------
5763

5864
::
5965

60-
flake8
61-
pylint mss
66+
$ flake8
67+
$ pylint mss
6268

6369
If there is no output, you are good ;)
6470

@@ -75,16 +81,15 @@ Dependencies
7581

7682
Install required packages::
7783

78-
pip install mypy-lang
84+
$ pip install mypy-lang
7985

8086

8187
Running mypy
8288
------------
8389

8490
::
8591

86-
mypy --check-untyped-defs --warn-incomplete-stub -m mss
87-
mypy --check-untyped-defs --warn-incomplete-stub mss
92+
$ sh check-types.sh -p mss
8893

8994

9095
Documentation
@@ -95,13 +100,13 @@ Dependencies
95100

96101
You will need `Sphinx <http://sphinx-doc.org/>`_::
97102

98-
pip install sphinx
103+
$ pip install sphinx
99104

100105

101106
How to build?
102107
-------------
103108

104109
::
105110

106-
cd docs
107-
make clean html
111+
$ cd docs
112+
$ make clean html

docs/source/installation.rst

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
.. highlight:: console
2+
13
============
24
Installation
35
============
@@ -7,18 +9,18 @@ Recommended way
79

810
Quite simple::
911

10-
pip install mss
12+
$ pip install mss
1113

1214

1315
From sources
1416
============
1517

1618
Alternatively, you can get a copy of the module from GitHub::
1719

18-
git clone https://github.com/BoboTiG/python-mss.git
19-
cd python-mss
20+
$ git clone https://github.com/BoboTiG/python-mss.git
21+
$ cd python-mss
2022

2123

2224
And then::
2325

24-
sudo python setup.py install
26+
$ sudo python setup.py install

tests/check-types.sh

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
export MYPYPATH="$(pwd)/stubs"
44

5-
~/.local/bin/mypy \
5+
mypy \
66
--silent-imports \
77
--disallow-untyped-calls \
88
--disallow-untyped-defs \

0 commit comments

Comments
 (0)