Skip to content

Commit

Permalink
fix release history
Browse files Browse the repository at this point in the history
  • Loading branch information
MacHu-GWU committed Jan 22, 2024
1 parent bd5874d commit 83b24f8
Show file tree
Hide file tree
Showing 6 changed files with 28 additions and 25 deletions.
6 changes: 0 additions & 6 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
@@ -1,9 +1,3 @@
.. contents::
:class: this-will-duplicate-information-and-it-is-still-useful-here
:depth: 1
:local:


Release v\ |release| (:ref:`What's new? <release_history>`).

.. include:: ../../README.rst
Expand Down
3 changes: 2 additions & 1 deletion docs/source/pathlib_mate/__init__.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,8 @@ sub packages and modules
.. toctree::
:maxdepth: 1

_paths <_paths>
api <api>
hashes <hashes>
helper <helper>
mate_attr_accessor <mate_attr_accessor>
Expand All @@ -19,6 +21,5 @@ sub packages and modules
mate_tool_box <mate_tool_box>
mate_tool_box_zip <mate_tool_box_zip>
pathlib2 <pathlib2>
python37_pathlib <python37_pathlib>
str_encode <str_encode>

5 changes: 5 additions & 0 deletions docs/source/pathlib_mate/_paths.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
_paths
======

.. automodule:: pathlib_mate._paths
:members:
5 changes: 5 additions & 0 deletions docs/source/pathlib_mate/api.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
api
===

.. automodule:: pathlib_mate.api
:members:
5 changes: 0 additions & 5 deletions docs/source/pathlib_mate/python37_pathlib.rst

This file was deleted.

29 changes: 16 additions & 13 deletions release-history.rst
Original file line number Diff line number Diff line change
@@ -1,8 +1,11 @@
.. _release_history:

Release and Version History
===========================
==============================================================================


x.x.x (TODO)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
------------------------------------------------------------------------------
**Features and Improvements**

**Minor Improvements**
Expand All @@ -13,14 +16,14 @@ x.x.x (TODO)


1.3.2 (2024-01-21)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
------------------------------------------------------------------------------
**Minor Improvements**

- Add type hint for most methods from ``pathlib2.py``.


1.3.1 (2023-12-19)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
------------------------------------------------------------------------------
**🚨 Breaking Change**

- Drop support for Python 2.7 and 3.6. Only support Python 3.7+.
Expand All @@ -44,14 +47,14 @@ x.x.x (TODO)


1.2.1 (2022-12-29)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
------------------------------------------------------------------------------
**Minor Improvements**

- add ``Path.temp_cwd`` method.


1.1.1 (2022-11-08)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
------------------------------------------------------------------------------
**Minor Improvements**

- more coverage test for ``Path.make_zip_archive`` method
Expand All @@ -63,7 +66,7 @@ x.x.x (TODO)


1.0.3 (2022-03-26)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
------------------------------------------------------------------------------
**Features and Improvements**

- add ``dir_here`` method.
Expand All @@ -81,14 +84,14 @@ x.x.x (TODO)


1.0.2 (2021-12-11)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
------------------------------------------------------------------------------
**Features and Improvements**

- add ``remove_if_exists`` and ``mkdir_if_not_exists`` syntax sugar method.


1.0.1 (2020-12-04) Feature Improvement
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
------------------------------------------------------------------------------
**Features and Improvements**

- add ``atomic_write_bytes`` and ``atomic_write_text`` method. Preventing overwriting existing file with incomplete data.
Expand All @@ -104,7 +107,7 @@ x.x.x (TODO)


1.0.0 (2020-03-14) First Production Ready Version
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
------------------------------------------------------------------------------
**Features and Improvements**

- type hint support for all method.
Expand All @@ -119,10 +122,10 @@ x.x.x (TODO)


0.0.11 (2017-08-31) MileStone
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
------------------------------------------------------------------------------
A stable, rich features, fully tested version.


0.0.1 (2016-09-07)
~~~~~~~~~~~~~~~~~~
- First release
------------------------------------------------------------------------------
- First release

0 comments on commit 83b24f8

Please sign in to comment.