Skip to content

Commit 482df04

Browse files
committed
Use rst format to reference issues and contributors in changelog
1 parent 5b62de8 commit 482df04

File tree

1 file changed

+56
-16
lines changed

1 file changed

+56
-16
lines changed

docs/changelog.rst

Lines changed: 56 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -14,20 +14,29 @@ Upcoming release
1414
--------------------------
1515

1616
- Add ``--start-live-server``/``--no-start-live-server`` options to prevent
17-
live server from starting automatically (#36), thanks to @EliRibble.
17+
live server from starting automatically (`#36`_), thanks to `@EliRibble`_.
1818

1919
- Fix title formatting in documentation.
2020

21+
22+
.. _#36: https://github.com/vitalk/pytest-flask/issues/36
23+
.. _@EliRibble: https://github.com/EliRibble
24+
25+
2126
0.9.0 (compared to 0.8.1)
2227
-------------------------
2328

2429
- Rename marker used to pass options to application, e.g. ``pytest.mark.app``
25-
is now ``pytest.mark.options`` (#35).
30+
is now ``pytest.mark.options`` (`#35`_).
2631

2732
- Documentation badge points to the package documentation.
2833

2934
- Add Travis CI configuration to ensure the tests are passed in supported
30-
environments (#32).
35+
environments (`#32`_).
36+
37+
38+
.. _#32: https://github.com/vitalk/pytest-flask/issues/32
39+
.. _#35: https://github.com/vitalk/pytest-flask/issues/35
3140

3241
0.8.1
3342
-----
@@ -38,12 +47,16 @@ Upcoming release
3847
-----
3948

4049
- New ``request_ctx`` fixture which contains all request relevant
41-
information (#29).
50+
information (`#29`_).
51+
52+
.. _#29: https://github.com/vitalk/pytest-flask/issues/29
4253

4354
0.7.5
4455
-----
4556

46-
- Use pytest ``monkeypath`` fixture to teardown application config (#27).
57+
- Use pytest ``monkeypath`` fixture to teardown application config (`#27`_).
58+
59+
.. _#27: https://github.com/vitalk/pytest-flask/issues/27
4760

4861
0.7.4
4962
-----
@@ -53,7 +66,9 @@ Upcoming release
5366
0.7.3
5467
-----
5568

56-
- Use retina-ready badges in documentation (#21).
69+
- Use retina-ready badges in documentation (`#21`_).
70+
71+
.. _#21: https://github.com/vitalk/pytest-flask/issues/21
5772

5873
0.7.2
5974
-----
@@ -63,44 +78,67 @@ Upcoming release
6378
0.7.1
6479
-----
6580

66-
- Single-sourcing package version (#24), as per `"Python Packaging User Guide"
81+
- Single-sourcing package version (`#24`_), as per `"Python Packaging User Guide"
6782
<https://packaging.python.org/en/latest/single_source_version.html#single-sourcing-the-version>`_.
6883

84+
.. _#24: https://github.com/vitalk/pytest-flask/issues/24
85+
6986
0.7.0
7087
-----
7188

72-
- Add package documentation (#20).
89+
- Add package documentation (`#20`_).
90+
91+
.. _#20: https://github.com/vitalk/pytest-flask/issues/20
7392

7493
0.6.3
7594
-----
7695

77-
- Better documentation in README with reST formatting (#18), thanks to @greedo.
96+
- Better documentation in README with reST formatting (`#18`_), thanks
97+
to `@greedo`_.
98+
99+
100+
.. _#18: https://github.com/vitalk/pytest-flask/issues/18
101+
.. _@greedo: https://github.com/greedo
78102

79103
0.6.2
80104
-----
81105

82-
- Release the random port before starting the application live server (#17),
83-
thanks to @davehunt.
106+
- Release the random port before starting the application live server (`#17`_),
107+
thanks to `@davehunt`_.
108+
109+
110+
.. _#17: https://github.com/vitalk/pytest-flask/issues/17
111+
.. _@davehunt: https://github.com/davehunt
84112

85113
0.6.1
86114
-----
87115

88116
- Bind live server to a random port instead of 5000 or whatever is passed on
89117
the command line, so it’s possible to execute tests in parallel via
90-
pytest-dev/pytest-xdist (#15). Thanks to @davehunt.
118+
pytest-dev/pytest-xdist (`#15`_). Thanks to `@davehunt`_.
91119

92120
- Remove ``--liveserver-port`` option.
93121

122+
123+
.. _#15: https://github.com/vitalk/pytest-flask/issues/15
124+
.. _@davehunt: https://github.com/davehunt
125+
94126
0.6.0
95127
-----
96128

97-
- Fix typo in option help for ``--liveserver-port``, thanks to @svenstaro.
129+
- Fix typo in option help for ``--liveserver-port``, thanks to `@svenstaro`_.
130+
131+
.. _@svenstaro: https://github.com/svenstaro
98132

99133
0.5.0
100134
-----
101135

102-
- Add ``live_server`` fixture uses to run application in the background (#11),
103-
thanks to @svenstaro.
136+
- Add ``live_server`` fixture uses to run application in the background (`#11`_),
137+
thanks to `@svenstaro`_.
138+
139+
140+
.. _#11: https://github.com/vitalk/pytest-flask/issues/11
141+
.. _@svenstaro: https://github.com/svenstaro
104142

105143
0.4.0
106144
-----
@@ -110,7 +148,9 @@ Upcoming release
110148
0.3.4
111149
-----
112150

113-
- Include package requirements into distribution (#8).
151+
- Include package requirements into distribution (`#8`_).
152+
153+
.. _#8: https://github.com/vitalk/pytest-flask/issues/8
114154

115155
0.3.3
116156
-----

0 commit comments

Comments
 (0)