Skip to content

Commit

Permalink
Fix change log syntax
Browse files Browse the repository at this point in the history
  • Loading branch information
@AA-Turner
AA-Turner committed Jul 15, 2024
1 parent d8361f8 commit bbe440c
Showing 1 changed file with 39 additions and 37 deletions.
76 changes: 39 additions & 37 deletions docs/changelog.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -35,104 +35,106 @@ Change log
0.3.1
#####

* Include tests in sdist
* Include tests in sdist

0.3.0
#####

* First release from ashb/sphinx-argparse
* Declare that parallel builds are supported (issue #131).
* First release from ashb/sphinx-argparse
* Declare that parallel builds are supported (`issue #105`_).

.. _issue #105: https://github.com/alex-rudakov/sphinx-argparse/pull/105

0.2.5
#####

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

0.2.4
#####

* Various bug fixes and documentation updates.
* Various bug fixes and documentation updates.

0.2.3
#####

* Fixed a variety of issues, such as with `@replace` (issue #99). Thanks to @evgeni
* You can now skip sections with `@skip`. Thanks to @evgeni
* Fixed handling of the epilog
* Fixed a variety of issues, such as with `@replace` (issue #99). Thanks to @evgeni
* You can now skip sections with `@skip`. Thanks to @evgeni
* Fixed handling of the epilog

0.2.2
#####

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

0.2.1
#####

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

0.2.0
#####

* 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>`_.
* 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>`_.
* Fixed quoting of default strings (issue `#59 <https://github.com/ribozz/sphinx-argparse/issues/59>`_).
* Added the `:noepilog:` and `:nodescription:` options, thanks to @arewm.
* Added the `:nosubcommand:` option, thanks to @arewm.
* 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>`_.
* 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>`_.
* Fixed quoting of default strings (issue `#59 <https://github.com/alex-rudakov/sphinx-argparse/issues/59>`_).
* Added the `:noepilog:` and `:nodescription:` options, thanks to @arewm.
* Added the `:nosubcommand:` option, thanks to @arewm.

0.1.17
######

* 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.
* 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.

0.1.16
######

* 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).
* Fixed various typos (thanks to users mikeantonacci, brondsem, and tony)
* 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.
* The package is now a bit more robust to incorrectly spelling module names (#39, courtesy of Gabriel Falcão)
* Added support for argparse groups (thanks to Fidel Ramirez)
* 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).
* Fixed various typos (thanks to users mikeantonacci, brondsem, and tony)
* 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.
* The package is now a bit more robust to incorrectly spelling module names (#39, courtesy of Gabriel Falcão)
* Added support for argparse groups (thanks to Fidel Ramirez)

0.1.15
######

* Fixed malformed docutils DOM in manpages (Matt Boyer)
* Fixed malformed docutils DOM in manpages (Matt Boyer)


0.1.14
######

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

0.1.13
######

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

0.1.12
######

* Improved error reporting (James Anderson)
* Improved error reporting (James Anderson)

0.1.11
######

* Fixed stupid bug, prevented things working on py3 (Alex Rudakov)
* added tox configuration for tests
* Fixed stupid bug, prevented things working on py3 (Alex Rudakov)
* added tox configuration for tests

0.1.10
######

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

0.1.9
######
Expand Down

0 comments on commit bbe440c

Please sign in to comment.