Skip to content

Commit bbe440c

Browse files
committed
Fix change log syntax
1 parent d8361f8 commit bbe440c

File tree

1 file changed

+39
-37
lines changed

1 file changed

+39
-37
lines changed

docs/changelog.rst

Lines changed: 39 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -35,104 +35,106 @@ Change log
3535
0.3.1
3636
#####
3737

38-
* Include tests in sdist
38+
* Include tests in sdist
3939

4040
0.3.0
4141
#####
4242

43-
* First release from ashb/sphinx-argparse
44-
* Declare that parallel builds are supported (issue #131).
43+
* First release from ashb/sphinx-argparse
44+
* Declare that parallel builds are supported (`issue #105`_).
45+
46+
.. _issue #105: https://github.com/alex-rudakov/sphinx-argparse/pull/105
4547

4648
0.2.5
4749
#####
4850

49-
* A more verbose error message is now printed if there's an issue during importing a script (issue #102).
51+
* A more verbose error message is now printed if there's an issue during importing a script (issue #102).
5052

5153
0.2.4
5254
#####
5355

54-
* Various bug fixes and documentation updates.
56+
* Various bug fixes and documentation updates.
5557

5658
0.2.3
5759
#####
5860

59-
* Fixed a variety of issues, such as with `@replace` (issue #99). Thanks to @evgeni
60-
* You can now skip sections with `@skip`. Thanks to @evgeni
61-
* Fixed handling of the epilog
61+
* Fixed a variety of issues, such as with `@replace` (issue #99). Thanks to @evgeni
62+
* You can now skip sections with `@skip`. Thanks to @evgeni
63+
* Fixed handling of the epilog
6264

6365
0.2.2
6466
#####
6567

66-
* CommonMark is now only imported if absolutely required. This should fix failures on read the docs. Thanks to @Chilipp for fixing this!
68+
* CommonMark is now only imported if absolutely required. This should fix failures on read the docs. Thanks to @Chilipp for fixing this!
6769

6870
0.2.1
6971
#####
7072

71-
* Stopped importing `sphinx.util.compat`, which was causing issues like that seen in `#65 <https://github.com/ribozz/sphinx-argparse/issues/65>`_
73+
* Stopped importing `sphinx.util.compat`, which was causing issues like that seen in `#65 <https://github.com/alex-rudakov/sphinx-argparse/issues/65>`_
7274

7375
0.2.0
7476
#####
7577

76-
* Section titles can now be used in tables of contents and linked to. The title itself is also used as the anchor. In the case of repeated names `_replicateX`, where `X` is a number, is prepended to ensure that all titles are uniquely linkable. This was bug `#46 <https://github.com/ribozz/sphinx-argparse/issues/46>`_.
77-
* The positional (aka required) and named (aka optional) option sections are now named "Positional Arguments" and "Named Arguments", for the sake of clarity (e.g., named arguments can be required). This was issue `#58 <https://github.com/ribozz/sphinx-argparse/issues/58>`_.
78-
* Fixed quoting of default strings (issue `#59 <https://github.com/ribozz/sphinx-argparse/issues/59>`_).
79-
* Added the `:noepilog:` and `:nodescription:` options, thanks to @arewm.
80-
* Added the `:nosubcommand:` option, thanks to @arewm.
78+
* Section titles can now be used in tables of contents and linked to. The title itself is also used as the anchor. In the case of repeated names `_replicateX`, where `X` is a number, is prepended to ensure that all titles are uniquely linkable. This was bug `#46 <https://github.com/alex-rudakov/sphinx-argparse/issues/46>`_.
79+
* The positional (aka required) and named (aka optional) option sections are now named "Positional Arguments" and "Named Arguments", for the sake of clarity (e.g., named arguments can be required). This was issue `#58 <https://github.com/alex-rudakov/sphinx-argparse/issues/58>`_.
80+
* Fixed quoting of default strings (issue `#59 <https://github.com/alex-rudakov/sphinx-argparse/issues/59>`_).
81+
* Added the `:noepilog:` and `:nodescription:` options, thanks to @arewm.
82+
* Added the `:nosubcommand:` option, thanks to @arewm.
8183

8284
0.1.17
8385
######
8486

85-
* Fixed handling of argument groups (this was bug `#49 <https://github.com/ribozz/sphinx-argparse/issues/49>`_). Thanks to @croth1 for reporting this bug. Note that now position arguments (also known as required arguments) within argument groups are now also handled correctly.
87+
* Fixed handling of argument groups (this was bug `#49 <https://github.com/alex-rudakov/sphinx-argparse/issues/49>`_). Thanks to @croth1 for reporting this bug. Note that now position arguments (also known as required arguments) within argument groups are now also handled correctly.
8688

8789
0.1.16
8890
######
8991

90-
* Added a `:nodefaultconst:` directive, which is similar to the `:nodefault:` directive, but applies only to `store_true`, `store_false`, and `store_const` (e.g., it will hide the "=True" part in the output, since that can be misleading to users).
91-
* Fixed various typos (thanks to users mikeantonacci, brondsem, and tony)
92-
* Format specifiers (e.g., `%(prog)s` and `%(default)s`) are now filled in (if possible) in help sections. If there's a missing keyword, then nothing will be filled in. This was issue #27.
93-
* The package is now a bit more robust to incorrectly spelling module names (#39, courtesy of Gabriel Falcão)
94-
* Added support for argparse groups (thanks to Fidel Ramirez)
92+
* Added a `:nodefaultconst:` directive, which is similar to the `:nodefault:` directive, but applies only to `store_true`, `store_false`, and `store_const` (e.g., it will hide the "=True" part in the output, since that can be misleading to users).
93+
* Fixed various typos (thanks to users mikeantonacci, brondsem, and tony)
94+
* Format specifiers (e.g., `%(prog)s` and `%(default)s`) are now filled in (if possible) in help sections. If there's a missing keyword, then nothing will be filled in. This was issue #27.
95+
* The package is now a bit more robust to incorrectly spelling module names (#39, courtesy of Gabriel Falcão)
96+
* Added support for argparse groups (thanks to Fidel Ramirez)
9597

9698
0.1.15
9799
######
98100

99-
* Fixed malformed docutils DOM in manpages (Matt Boyer)
101+
* Fixed malformed docutils DOM in manpages (Matt Boyer)
100102

101103

102104
0.1.14
103105
######
104106

105-
* Support for aliasing arguments #22 (Campbell Barton)
106-
* Support for nested arguments #23 (Campbell Barton)
107-
* Support for subcommand descriptions #24 (Campbell Barton)
108-
* Improved parsing of content of `epilog` and `description` #25 (Louis - https://github.com/paternal)
109-
* Added 'passparser' option (David Hoese)
107+
* Support for aliasing arguments #22 (Campbell Barton)
108+
* Support for nested arguments #23 (Campbell Barton)
109+
* Support for subcommand descriptions #24 (Campbell Barton)
110+
* Improved parsing of content of `epilog` and `description` #25 (Louis - https://github.com/paternal)
111+
* Added 'passparser' option (David Hoese)
110112

111113
0.1.13
112114
######
113115

114-
* Bugfix: Choices are not always strings (Robert Langlois)
115-
* Polished small mistakes in usage documentation (Dean Malmgren)
116-
* Started to improve man-pages support (Zygmunt Krynicki)
116+
* Bugfix: Choices are not always strings (Robert Langlois)
117+
* Polished small mistakes in usage documentation (Dean Malmgren)
118+
* Started to improve man-pages support (Zygmunt Krynicki)
117119

118120
0.1.12
119121
######
120122

121-
* Improved error reporting (James Anderson)
123+
* Improved error reporting (James Anderson)
122124

123125
0.1.11
124126
######
125127

126-
* Fixed stupid bug, prevented things working on py3 (Alex Rudakov)
127-
* added tox configuration for tests
128+
* Fixed stupid bug, prevented things working on py3 (Alex Rudakov)
129+
* added tox configuration for tests
128130

129131
0.1.10
130132
######
131133

132-
* Remove the ugly new line in the end of usage string (Vadim Markovtsev)
133-
* Issue #9 Display argument choises (Proposed by Felix-neko, done by Alex Rudakov)
134-
* :ref: syntax for specifying path to parser instance. Issue #7 (Proposed by David Cottrell, Implemented by Alex Rudakov)
135-
* Updated docs to read the docs theme
134+
* Remove the ugly new line in the end of usage string (Vadim Markovtsev)
135+
* Issue #9 Display argument choises (Proposed by Felix-neko, done by Alex Rudakov)
136+
* :ref: syntax for specifying path to parser instance. Issue #7 (Proposed by David Cottrell, Implemented by Alex Rudakov)
137+
* Updated docs to read the docs theme
136138

137139
0.1.9
138140
######

0 commit comments

Comments
 (0)