Skip to content

Commit

Permalink
Version 2.2.0
Browse files Browse the repository at this point in the history
  • Loading branch information
cbillingham committed Oct 20, 2024
1 parent a161988 commit 0a4cf5d
Show file tree
Hide file tree
Showing 5 changed files with 25 additions and 12 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -107,8 +107,8 @@ For the versions available, see the tags on the repository.

We tried really hard to have this package support both Python 2 and 3 for a
long time. We've dropped Python 2 support officially. Its just become
cumbersome to test with. However, the code will probably still work in
Python 2.7+ *I think*. Good luck!
cumbersome to automate tests for. However, the code will probably still
work in Python 2.7+ *I think*. Good luck!

## License

Expand Down
22 changes: 19 additions & 3 deletions RELEASE_NOTES.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,28 @@ Release Notes
Versions follow `Semantic Versioning <https://semver.org/>`_
(``<major>.<minor>.<patch>``).

v2.2.0 (2024-10-20)
-------------------
Features
^^^^^^^^
* Add new config option to convert epytext markup to reST equivalents. (#7)
* Support not writing return types for google and reST when use_types is off. (#4)

Bugfixes
^^^^^^^^
* Fix as parsing error when using ellipsis in nested scopes. (#11)
* Fix issue where docstring after variable assignment were getting skipped by module parser.

Misc
^^^^
* Drop official support for python2.7. We will no longer run tests
against python2.7 when making changes.

v2.1.0 (2023-01-30)
-------------------
Features
^^^^^^^^
* Support async function definitions in docstring parsing.
* Support async function definitions in docstring parsing. (#8)

v2.0.0 (2020-07-11)
-------------------
Expand All @@ -29,8 +46,7 @@ v1.2.0 (2020-06-08)

Features
^^^^^^^^
* `#1 <https://github.com/cbillingham/docconvert/issues/1>`_:
Support converting docstrings nested inside functions.
* Support converting docstrings nested inside functions. (#1)
* Add support for Python 3.8.

v1.1.0 (2018-06-17)
Expand Down
7 changes: 2 additions & 5 deletions doc/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -61,9 +61,9 @@
# built documents.
#
# The short X.Y version.
version = "2.1"
version = "2.2"
# The full version, including alpha/beta/rc tags.
release = "2.1.0"
release = "2.2.0"

# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
Expand Down Expand Up @@ -110,10 +110,7 @@

# The theme to use for HTML and HTML Help pages. Major themes that come with
# Sphinx are currently 'default' and 'sphinxdoc'.
import sphinx_rtd_theme

html_theme = "sphinx_rtd_theme"
html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]

# Theme options are theme-specific and customize the look and feel of a theme
# further. For a list of options available for each theme, see the
Expand Down
2 changes: 1 addition & 1 deletion doc/source/intro.rst
Original file line number Diff line number Diff line change
Expand Up @@ -269,7 +269,7 @@ This option has 3 modes:

- ``I{text}`` becomes ``*text*``
- ``B{text}`` stays as ``**text**``
- ``C{source code}`` becomes ``` ``source code`` ```
- ``C{source code}`` becomes ````source code````
- ``M{m*x+b}`` becomes ``:math:`m*x+b```

- ``"types"``: All epytext markup is converted. In addition, in type strings,
Expand Down
2 changes: 1 addition & 1 deletion setup.cfg
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[metadata]
name = docconvert
version = 2.1.0
version = 2.2.0
description = Convert and conform package docstrings to a new style
long_description = file: README.md
long_description_content_type = text/markdown
Expand Down

0 comments on commit 0a4cf5d

Please sign in to comment.