bump docs version for 20.0.0 and write changelog

This commit is contained in:
Mahmoud Hashemi 2020-01-08 15:32:03 -08:00
parent 79b78293f0
commit c847dea034
5 changed files with 32 additions and 17 deletions

View File

@ -1,24 +1,32 @@
boltons Changelog
=================
Since February 20, 2013 there have been 40 releases and 1386 commits for
an average of one 35-commit release about every 10 weeks.
Since February 20, 2013 there have been 41 releases and 1405 commits for
an average of one 34-commit release about every 8 weeks.
19.4.0
20.0.0
------
*(Unreleased)*
*January 8, 2020*
New module [pathutils][pathutils]:
* [pathutils.augpath][pathutils.augpath] augments a path by modifying its components
* [pathutils.shrinkuser][pathutils.shrinkuser] inverts :func:`os.path.expanduser`.
* [pathutils.expandpath][pathutils.expandpath] shell-like environ and tilde expansion
[pathutils.augpath]: https://boltons.readthedocs.io/en/latest/funcutils.html#boltons.pathutils.augpath
[pathutils.shrinkuser]: https://boltons.readthedocs.io/en/latest/funcutils.html#boltons.pathutils.shrinkuser
[pathutils.expandpath]: https://boltons.readthedocs.io/en/latest/funcutils.html#boltons.pathutils.expandpath
* New module [pathutils][pathutils]:
* [pathutils.augpath][pathutils.augpath] augments a path by modifying its components
* [pathutils.shrinkuser][pathutils.shrinkuser] inverts :func:`os.path.expanduser`.
* [pathutils.expandpath][pathutils.expandpath] shell-like environ and tilde expansion
* add `include_dirs` param to [fileutils.iter_find_files][fileutils.iter_find_files]
* Make [funcutils.format_invocation][funcutils.format_invocation] more deterministic
* add [strutils.unwrap_text][strutils.unwrap_text] which does what you think to wrapped text
* Py3 fixes
* [strutils.chunked][strutils.chunked] to work with the `bytes` type ([#231][i231])
* [cacheutils.ThresholdCounter][cacheutils.ThresholdCounter]'s `get_common_count()`
[i231]: https://github.com/mahmoud/boltons/issues/231
[pathutils]: https://boltons.readthedocs.io/en/latest/pathutils.html
[pathutils.augpath]: https://boltons.readthedocs.io/en/latest/pathutils.html#boltons.pathutils.augpath
[pathutils.augpath]: https://boltons.readthedocs.io/en/latest/pathutils.html#boltons.pathutils.augpath
[pathutils.shrinkuser]: https://boltons.readthedocs.io/en/latest/pathutils.html#boltons.pathutils.shrinkuser
[pathutils.expandpath]: https://boltons.readthedocs.io/en/latest/pathutils.html#boltons.pathutils.expandpath
[strutils.unwrap_text]: https://boltons.readthedocs.io/en/latest/strutils.html#boltons.strutils.unwrap_text
19.3.0
------

View File

@ -42,7 +42,7 @@ __all__ = ['camel2under', 'under2camel', 'slugify', 'split_punct_ws',
'asciify', 'is_ascii', 'is_uuid', 'html2text', 'strip_ansi',
'bytes2human', 'find_hashtags', 'a10n', 'gzip_bytes', 'gunzip_bytes',
'iter_splitlines', 'indent', 'escape_shell_args',
'args2cmd', 'args2sh', 'parse_int_list', 'format_int_list']
'args2cmd', 'args2sh', 'parse_int_list', 'format_int_list', 'unwrap_text']
_punct_ws_str = string.punctuation + string.whitespace

View File

@ -97,11 +97,11 @@ master_doc = 'index'
# General information about the project.
project = u'boltons'
copyright = u'2019, Mahmoud Hashemi'
copyright = u'2020, Mahmoud Hashemi'
author = u'Mahmoud Hashemi'
version = '19.3'
release = '19.3.0'
version = '20.0'
release = '20.0.0'
if os.name != 'nt':
today_fmt = '%B %d, %Y'

View File

@ -117,6 +117,7 @@ Section listing
mathutils
mboxutils
namedutils
pathutils
queueutils
setutils
socketutils

6
docs/pathutils.rst Normal file
View File

@ -0,0 +1,6 @@
``pathutils`` - Filesystem fun
==============================
.. automodule:: boltons.pathutils
:members:
:undoc-members: