Skip to content

Commit ef42007

Browse files
authored
Specify explicit language for literal blocks in CONTRIBUTING.rst to reduce warnings in doc builds (#760)
1 parent 89011c9 commit ef42007

File tree

1 file changed

+24
-10
lines changed

1 file changed

+24
-10
lines changed

CONTRIBUTING.rst

Lines changed: 24 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -51,25 +51,33 @@ We expect you to use a python virtual environment to run our tests.
5151

5252
There are several ways to make a virtual environment.
5353

54-
If you like to use *virtualenv* please run::
54+
If you like to use *virtualenv* please run:
55+
56+
.. code-block:: sh
5557
5658
$ cd aiomysql
57-
$ virtualenv --python=`which python3` venv
59+
$ virtualenv --python="$(which python3)" venv
60+
61+
For standard python *venv*:
5862

59-
For standard python *venv*::
63+
.. code-block:: sh
6064
6165
$ cd aiomysql
6266
$ python3 -m venv venv
6367
64-
For *virtualenvwrapper*::
68+
For *virtualenvwrapper*:
69+
70+
.. code-block:: sh
6571
6672
$ cd aiomysql
67-
$ mkvirtualenv --python=`which python3` aiomysql
73+
$ mkvirtualenv --python="$(which python3)" aiomysql
6874
6975
There are other tools like *pyvenv* but you know the rule of thumb
7076
now: create a python3 virtual environment and activate it.
7177

72-
After that please install libraries required for development::
78+
After that please install libraries required for development:
79+
80+
.. code-block:: sh
7381
7482
$ pip install -r requirements-dev.txt
7583
@@ -83,7 +91,7 @@ use this values by default. But you always can override host/port, user and
8391
password in `aiomysql/tests/base.py` file or install corresponding environment
8492
variables. Tests require two databases to be created before running suit:
8593

86-
::
94+
.. code-block:: sh
8795
8896
$ mysql -u root
8997
mysql> CREATE DATABASE test_pymysql DEFAULT CHARACTER SET utf8 DEFAULT COLLATE utf8_general_ci;
@@ -94,7 +102,9 @@ Run aiomysql test suite
94102
-----------------------
95103

96104
After all the preconditions are met you can run tests typing the next
97-
command::
105+
command:
106+
107+
.. code-block:: sh
98108
99109
$ make test
100110
@@ -113,7 +123,9 @@ Tests coverage
113123

114124
We are trying hard to have good test coverage; please don't make it worse.
115125

116-
Use::
126+
Use:
127+
128+
.. code-block:: sh
117129
118130
$ make cov
119131
@@ -130,7 +142,9 @@ Documentation
130142

131143
We encourage documentation improvements.
132144

133-
Please before making a Pull Request about documentation changes run::
145+
Please before making a Pull Request about documentation changes run:
146+
147+
.. code-block:: sh
134148
135149
$ make doc
136150

0 commit comments

Comments
 (0)