@@ -5,12 +5,14 @@ Collaborators are welcome!
5
5
6
6
#. Check for open issues or open a fresh issue to start a discussion around a
7
7
bug.
8
- #. Fork ` the repository < https://github.com/grantjenks/python-sortedcontainers > `_ on
9
- GitHub and start making your changes to a new branch.
8
+ #. Fork the ` repository `_ on GitHub and start making your changes to a new
9
+ branch.
10
10
#. Write a test which shows that the bug was fixed.
11
11
#. Send a pull request and bug the maintainer until it gets merged and
12
12
published :)
13
13
14
+ .. _`repository` : https://github.com/grantjenks/python-sortedcontainers
15
+
14
16
Development Lead
15
17
----------------
16
18
@@ -37,7 +39,7 @@ is to clone the repository from GitHub::
37
39
Development Dependencies
38
40
------------------------
39
41
40
- Install development dependencies with `pip < https://pypi.org/project/pip/ > `_::
42
+ Install development dependencies with `pip `_::
41
43
42
44
$ pip install -r requirements.txt
43
45
@@ -48,12 +50,13 @@ Some alternative implementations, such as `banyan`, may have issues when
48
50
installing on Windows. You can still develop :doc: `Sorted Containers<index> `
49
51
without these packages. They will be omitted from benchmarking.
50
52
53
+ .. _`pip` : https://pypi.org/project/pip/
54
+
51
55
Testing
52
56
-------
53
57
54
- Testing uses `tox <https://pypi.org/project/tox/ >`_. If you don't want to
55
- install all the development requirements, then, after downloading, you can
56
- simply run::
58
+ Testing uses `tox `_. If you don't want to install all the development
59
+ requirements, then, after downloading, you can simply run::
57
60
58
61
$ python setup.py test
59
62
@@ -113,7 +116,7 @@ and run the tests.
113
116
py36: commands succeeded
114
117
lint: commands succeeded
115
118
116
- Coverage testing uses `pytest-cov < https://pypi.org/project/pytest-cov/ > `_:
119
+ Coverage testing uses `pytest-cov `_:
117
120
118
121
::
119
122
@@ -220,5 +223,10 @@ of Python:
220
223
* PyPy
221
224
* PyPy3
222
225
223
- Life will feel much saner if you use `virtualenv <http://www.virtualenv.org/ >`_
224
- and `tox ` to manage and test each of the runtimes.
226
+ Life will feel much saner if you use `venv `_ or `virtualenv `_ and `tox `_ to
227
+ manage and test each of the runtimes.
228
+
229
+ .. _`tox` : https://pypi.org/project/tox/
230
+ .. _`pytest-cov` : https://pypi.org/project/pytest-cov/
231
+ .. _`venv` : https://docs.python.org/3/library/venv.html
232
+ .. _`virtualenv` : https://pypi.org/project/virtualenv/
0 commit comments