Skip to content

Commit ee8de0c

Browse files
dpryan79dpryan79
authored
Merge pull request #72 from ribozz/moveChanges68
Move changes68
2 parents a7b805b + 6fc3c54 commit ee8de0c

File tree

4 files changed

+137
-117
lines changed

4 files changed

+137
-117
lines changed

‎README.md‎

Lines changed: 6 additions & 114 deletions
Original file line numberDiff line numberDiff line change
@@ -1,120 +1,12 @@
1-
[![Build Status](https://travis-ci.org/ribozz/sphinx-argparse.svg?branch=master)](https://travis-ci.org/ribozz/sphinx-argparse) [![Documentation Status](https://readthedocs.org/projects/sphinx-argparse/badge/?version=stable)](http://sphinx-argparse.readthedocs.org/) [![PyPI version](https://badge.fury.io/py/sphinx-argparse.svg)](https://badge.fury.io/py/sphinx-argparse) [Install with conda](https://anaconda.org/conda-forge/sphinx-argparse/badges/installer/conda.svg) [Conda downloads](https://anaconda.org/conda-forge/sphinx-argparse/badges/downloads.svg)
1+
[![Build Status](https://travis-ci.org/ribozz/sphinx-argparse.svg?branch=master)](https://travis-ci.org/ribozz/sphinx-argparse)
2+
[![Documentation Status](https://readthedocs.org/projects/sphinx-argparse/badge/?version=stable)](http://sphinx-argparse.readthedocs.org/)
3+
[![PyPI version](https://badge.fury.io/py/sphinx-argparse.svg)](https://badge.fury.io/py/sphinx-argparse)
4+
[![Install with conda](https://anaconda.org/conda-forge/sphinx-argparse/badges/installer/conda.svg)](https://github.com/conda-forge/sphinx-argparse-feedstock)
5+
![Conda downloads](https://anaconda.org/conda-forge/sphinx-argparse/badges/downloads.svg)
26

37
sphinx-argparse
48
===============
59

610
A sphinx extension that automatically documents argparse commands and options.
711

8-
For installation and usage details see the [documentation](http://sphinx-argparse.readthedocs.org/en/latest/).
9-
10-
Changelog & contributors
11-
========================
12-
13-
0.2.1
14-
-----
15-
16-
* Stopped importing `sphinx.util.compat`, which was causing issues like that seen in [#65](https://github.com/ribozz/sphinx-argparse/issues/65)
17-
18-
0.2.0
19-
-----
20-
21-
- 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.
22-
- 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.
23-
- Fixed quoting of default strings (issue #59).
24-
- Added the `:noepilogue:` and `:nodescription:` options, thanks to @arewm.
25-
- Added the `:nosubcommand:` option, thanks to @arewm.
26-
27-
0.1.17
28-
------
29-
30-
- 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.
31-
32-
0.1.16
33-
------
34-
35-
- 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).
36-
- Fixed various typos (thanks to users mikeantonacci, brondsem, and tony)
37-
- 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.
38-
- The package is now a bit more robust to incorrectly spelling module names (#39, courtesy of Gabriel Falcão)
39-
- Added support for argparse groups (thanks to Fidel Ramirez)
40-
41-
0.1.15
42-
------
43-
44-
- Fixed malformed docutils DOM in manpages (Matt Boyer)
45-
46-
47-
0.1.14
48-
------
49-
50-
- Support for aliasing arguments #22 (Campbell Barton)
51-
- Support for nested arguments #23 (Campbell Barton)
52-
- Support for subcommand descriptions #24 (Campbell Barton)
53-
- Improved parsing of content of `epilog` and `description` #25 (Louis - https://github.com/paternal)
54-
- Added 'passparser' option (David Hoese)
55-
56-
0.1.13
57-
------
58-
59-
- Bugfix: Choices are not always strings (Robert Langlois)
60-
- Polished small mistakes in usage documentation (Dean Malmgren)
61-
- Started to improve man-pages support (Zygmunt Krynicki)
62-
63-
0.1.12
64-
------
65-
66-
- Improved error reporting (James Anderson)
67-
68-
0.1.11
69-
------
70-
71-
- Fixed stupid bug, prevented things working on py3 (Alex Rudakov)
72-
- added tox configuration for tests
73-
74-
0.1.10
75-
------
76-
77-
- Remove the ugly new line in the end of usage string (Vadim Markovtsev)
78-
- Issue #9 Display argument choises (Proposed by Felix-neko, done by Alex Rudakov)
79-
- :ref: syntax for specifying path to parser instance. Issue #7 (Proposed by David Cottrell, Implemented by Alex Rudakov)
80-
- Updated docs to read the docs theme
81-
82-
0.1.9
83-
-----
84-
85-
Fix problem with python version comparison, when python reports it as "2.7.5+" (Alex Rudakov)
86-
87-
0.1.8
88-
-----
89-
90-
Argparse is not required anymore separate module as of python 2.7 (Mike Gleen)
91-
92-
0.1.7
93-
-----
94-
95-
-- Nothing -- Created by axident.
96-
97-
0.1.6
98-
-----
99-
100-
Adding :nodefault: directive that skips default values for options (Stephen Tridgell)
101-
102-
0.1.5
103-
-----
104-
105-
Fix issue: epilog is ignored (James Anderson - https://github.com/jamesra)
106-
107-
0.1.4
108-
-----
109-
110-
Fix issue #3: ==SUPPRESS== in option list with no default value
111-
112-
0.1.2
113-
-----
114-
115-
Fix issue with subcommands (by Tony Narlock - https://github.com/tony)
116-
117-
0.1.1
118-
-----
119-
120-
Initial version
12+
For installation and usage details see the [documentation](http://sphinx-argparse.readthedocs.org/en/latest/). The changelog is also [found there](http://sphinx-argparse.readthedocs.org/en/latest/changelog.html).

‎docs/changelog.rst‎

Lines changed: 112 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,112 @@
1+
**********
2+
Change log
3+
**********
4+
5+
0.2.1
6+
#####
7+
8+
* Stopped importing `sphinx.util.compat`, which was causing issues like that seen in `#65 <https://github.com/ribozz/sphinx-argparse/issues/65>`_
9+
10+
0.2.0
11+
#####
12+
13+
* 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>`_.
14+
* 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>`_.
15+
* Fixed quoting of default strings (issue `#59 <https://github.com/ribozz/sphinx-argparse/issues/59>`_).
16+
* Added the `:noepilogue:` and `:nodescription:` options, thanks to @arewm.
17+
* Added the `:nosubcommand:` option, thanks to @arewm.
18+
19+
0.1.17
20+
######
21+
22+
* 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.
23+
24+
0.1.16
25+
######
26+
27+
* 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).
28+
* Fixed various typos (thanks to users mikeantonacci, brondsem, and tony)
29+
* 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.
30+
* The package is now a bit more robust to incorrectly spelling module names (#39, courtesy of Gabriel Falcão)
31+
* Added support for argparse groups (thanks to Fidel Ramirez)
32+
33+
0.1.15
34+
######
35+
36+
* Fixed malformed docutils DOM in manpages (Matt Boyer)
37+
38+
39+
0.1.14
40+
######
41+
42+
* Support for aliasing arguments #22 (Campbell Barton)
43+
* Support for nested arguments #23 (Campbell Barton)
44+
* Support for subcommand descriptions #24 (Campbell Barton)
45+
* Improved parsing of content of `epilog` and `description` #25 (Louis - https://github.com/paternal)
46+
* Added 'passparser' option (David Hoese)
47+
48+
0.1.13
49+
######
50+
51+
* Bugfix: Choices are not always strings (Robert Langlois)
52+
* Polished small mistakes in usage documentation (Dean Malmgren)
53+
* Started to improve man-pages support (Zygmunt Krynicki)
54+
55+
0.1.12
56+
######
57+
58+
* Improved error reporting (James Anderson)
59+
60+
0.1.11
61+
######
62+
63+
* Fixed stupid bug, prevented things working on py3 (Alex Rudakov)
64+
* added tox configuration for tests
65+
66+
0.1.10
67+
######
68+
69+
* Remove the ugly new line in the end of usage string (Vadim Markovtsev)
70+
* Issue #9 Display argument choises (Proposed by Felix-neko, done by Alex Rudakov)
71+
* :ref: syntax for specifying path to parser instance. Issue #7 (Proposed by David Cottrell, Implemented by Alex Rudakov)
72+
* Updated docs to read the docs theme
73+
74+
0.1.9
75+
######
76+
77+
Fix problem with python version comparison, when python reports it as "2.7.5+" (Alex Rudakov)
78+
79+
0.1.8
80+
#####
81+
82+
Argparse is not required anymore separate module as of python 2.7 (Mike Gleen)
83+
84+
0.1.7
85+
#####
86+
87+
-- Nothing -- Created by accident.
88+
89+
0.1.6
90+
#####
91+
92+
Adding :nodefault: directive that skips default values for options (Stephen Tridgell)
93+
94+
0.1.5
95+
#####
96+
97+
Fix issue: epilog is ignored (James Anderson - https://github.com/jamesra)
98+
99+
0.1.4
100+
#####
101+
102+
Fix issue #3: ==SUPPRESS== in option list with no default value
103+
104+
0.1.2
105+
#####
106+
107+
Fix issue with subcommands (by Tony Narlock - https://github.com/tony)
108+
109+
0.1.1
110+
#####
111+
112+
Initial version

‎docs/index.rst‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@
1414
sample
1515
misc
1616
markdown
17+
changelog
1718
contrib
1819

1920

‎setup.py‎

Lines changed: 18 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,12 +15,27 @@ def getVersion():
1515
packages=[
1616
'sphinxarg',
1717
],
18-
url='',
18+
url='https://github.com/ribozz/sphinx-argparse',
1919
license='MIT',
2020
author='Aleksandr Rudakov and Devon Ryan',
2121
author_email='ribozz@gmail.com',
22-
description='Sphinx extension that automatically documents argparse commands and options',
23-
long_description='',
22+
description='A sphinx extension that automatically documents argparse commands and options',
23+
long_description="""A sphinx extension that automatically documents argparse commands and options.
24+
25+
For installation and usage details, see the `documentation <http://sphinx-argparse.readthedocs.org/en/latest/>`_.""",
26+
classifiers=[
27+
'Development Status :: 5 - Production/Stable',
28+
'Intended Audience :: Developers',
29+
'License :: OSI Approved :: MIT License',
30+
'Programming Language :: Python :: 2.7',
31+
'Programming Language :: Python :: 3.2',
32+
'Programming Language :: Python :: 3.3',
33+
'Programming Language :: Python :: 3.4',
34+
'Programming Language :: Python :: 3.5',
35+
'Programming Language :: Python :: 3.6',
36+
'Topic :: Documentation :: Sphinx',
37+
'Topic :: Software Development :: Documentation'
38+
],
2439
install_requires=[
2540
'sphinx>=1.2.0',
2641
'CommonMark>=0.5.6'

0 commit comments

Comments
 (0)