Change log

0.5.2

• Fix formatting of empty-string default values. Patch by Adam Turner.

0.5.1

• Fix autodoc_mock_imports support. Patch by Adam Turner.

• Properly declare supported Sphinx and Docutils versions. Patch by Adam Turner.

• Fix tests and ensure tests run in CI. Patch by Adam Turner.

0.5.0

• Add HTML tests to avoid regressions. Patch by Mike McKiernan in https://github.com/sphinx-doc/sphinx-argparse/pull/33

• Escape reStructuredText special characters in the default value. Patch by Robert Roos.

• Fix the options formatter for manpages. Patch by Felix Moessbauer in https://github.com/sphinx-doc/sphinx-argparse/pull/50

• Handle None return from shutil.which(). Patch by Om Vats in https://github.com/sphinx-doc/sphinx-argparse/pull/52

• Drop support for Python 3.7, 3.8, and 3.9. Patch by Adam Turner.

• Adopt Flit for packaging. Patch by Adam Turner.

• Make argument and option section IDs more unique. Patch by David Hoese in https://github.com/sphinx-doc/sphinx-argparse/pull/44

• Fix cases where a suppressed default was visible. Patch by Michele Riva in https://github.com/sphinx-doc/sphinx-argparse/pull/53

• Support autodoc_mock_imports. Patch by Adam Turner and Prajeesh Ag in https://github.com/sphinx-doc/sphinx-argparse/pull/35

0.4.0

• Minimum python version is now 3.7 by @ashb in https://github.com/sphinx-doc/sphinx-argparse/pull/25

• Fix anchor for toc by @Blaok in https://github.com/sphinx-doc/sphinx-argparse/pull/2

• feat: find executable filename to address #16 by @tsutterley in https://github.com/sphinx-doc/sphinx-argparse/pull/17

• Test against python 3.11 too by @ashb in https://github.com/sphinx-doc/sphinx-argparse/pull/22

0.3.1

• Include tests in sdist

0.3.0

• First release from ashb/sphinx-argparse

• Declare that parallel builds are supported (issue #105).

0.2.5

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

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

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!

0.2.1

• Stopped importing sphinx.util.compat, which was causing issues like that seen in #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.

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

• Fixed quoting of default strings (issue #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). 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)

0.1.15

• 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)

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)

0.1.12

• Improved error reporting (James Anderson)

0.1.11

• 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

0.1.9

Fix problem with python version comparison, when python reports it as “2.7.5+” (Alex Rudakov)

0.1.8

Argparse is not required anymore separate module as of python 2.7 (Mike Gleen)

0.1.7

– Nothing – Created by accident.

0.1.6

Adding :nodefault: directive that skips default values for options (Stephen Tridgell)

0.1.5

Fix issue: epilog is ignored (James Anderson - https://github.com/jamesra)

0.1.4

Fix issue #3: ==SUPPRESS== in option list with no default value

0.1.2

Fix issue with subcommands (by Tony Narlock - https://github.com/tony)

0.1.1

Initial version