MAINT bump version to v3.0.0

.circleci/config.yml

@@ -53,7 +53,6 @@ jobs:
           name: Check for PyPI compliance via twine
           working_directory: ~/project/
           command: |
-            pip install --progress-bar off twine
             twine check dist/`ls dist/ | grep .tar.gz`
       - run:
           name: Show installed Python packages

CHANGELOG.md

@@ -6,14 +6,14 @@ and this project adheres to [Semantic Versioning](https://semver.org/).
 
 ## [Unreleased]
 
-### API-breaking Changes Compared to v2.x.x
-* `jyutping_to_yale`: The default value of the keyword argument `as_list` has
-  been changed from `False` to `True`, so that this function is now more in
-  line with the other "jyutping_to_X" functions for returning a list.
-* `characters_to_jyutping`: The returned valued is now a list of segmented words,
-  where each is a 2-tuple of (Cantonese characters, Jyutping).
-  Previously, it was a list of Jyutping strings for the individual
-  Cantonese characters.
+### Added
+### Changed
+### Deprecated
+### Removed
+### Fixed
+### Security
+
+## [3.0.0] - 2020-10-25
 
 ### Added
 * Word segmentation:
@@ -33,13 +33,19 @@ and this project adheres to [Semantic Versioning](https://semver.org/).
 * Added support for Python 3.9.
 
 ### Changed
+
+#### API-breaking Changes
+
 * `jyutping_to_yale`: The default value of the keyword argument `as_list` has
   been changed from `False` to `True`, so that this function is now more in
   line with the other "jyutping_to_X" functions for returning a list.
 * `characters_to_jyutping`: The returned valued is now a list of segmented words,
   where each is a 2-tuple of (Cantonese characters, Jyutping).
   Previously, it was a list of Jyutping strings for the individual
   Cantonese characters.
+
+#### Non-API-breaking Changes
+
 * Switched documentation to the readthedocs theme and numpydoc docstring style.
 * Improved CircleCI builds with orbs.
 
@@ -50,8 +56,6 @@ and this project adheres to [Semantic Versioning](https://semver.org/).
     - `jyutping2tipa`
     - `jyutping2yale`
 
-### Removed
-### Fixed
 ### Security
 - Turned on HTTPS for the pycantonese.org domain.
 

docs/.buildinfo

@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: aa1c321eb2d8fed312ff82650e90147f
+config: 1421b8ba4f93402b1c34b71c2e0b63e6
 tags: 645f666f9bcd5a90fca523b33c5a78b7

docs/_modules/index.html

@@ -7,7 +7,7 @@
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
 
-  <title>Overview: module code &mdash; PyCantonese 2.4.1 documentation</title>
+  <title>Overview: module code &mdash; PyCantonese 3.0.0 documentation</title>
 
 
 
@@ -61,7 +61,7 @@
 
 
               <div class="version">
-                2.4.1
+                3.0.0
               </div>
 
 

docs/_modules/pycantonese/corpus.html

@@ -7,7 +7,7 @@
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
 
-  <title>pycantonese.corpus &mdash; PyCantonese 2.4.1 documentation</title>
+  <title>pycantonese.corpus &mdash; PyCantonese 3.0.0 documentation</title>
 
 
 
@@ -61,7 +61,7 @@
 
 
               <div class="version">
-                2.4.1
+                3.0.0
               </div>
 
 

docs/_modules/pycantonese/jyutping/characters.html

@@ -7,7 +7,7 @@
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
 
-  <title>pycantonese.jyutping.characters &mdash; PyCantonese 2.4.1 documentation</title>
+  <title>pycantonese.jyutping.characters &mdash; PyCantonese 3.0.0 documentation</title>
 
 
 
@@ -61,7 +61,7 @@
 
 
               <div class="version">
-                2.4.1
+                3.0.0
               </div>
 
 

docs/_modules/pycantonese/jyutping/parse_jyutping.html

@@ -7,7 +7,7 @@
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
 
-  <title>pycantonese.jyutping.parse_jyutping &mdash; PyCantonese 2.4.1 documentation</title>
+  <title>pycantonese.jyutping.parse_jyutping &mdash; PyCantonese 3.0.0 documentation</title>
 
 
 
@@ -61,7 +61,7 @@
 
 
               <div class="version">
-                2.4.1
+                3.0.0
               </div>
 
 

docs/_modules/pycantonese/jyutping/tipa.html

@@ -7,7 +7,7 @@
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
 
-  <title>pycantonese.jyutping.tipa &mdash; PyCantonese 2.4.1 documentation</title>
+  <title>pycantonese.jyutping.tipa &mdash; PyCantonese 3.0.0 documentation</title>
 
 
 
@@ -61,7 +61,7 @@
 
 
               <div class="version">
-                2.4.1
+                3.0.0
               </div>
 
 

docs/_modules/pycantonese/jyutping/yale.html

@@ -7,7 +7,7 @@
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
 
-  <title>pycantonese.jyutping.yale &mdash; PyCantonese 2.4.1 documentation</title>
+  <title>pycantonese.jyutping.yale &mdash; PyCantonese 3.0.0 documentation</title>
 
 
 
@@ -61,7 +61,7 @@
 
 
               <div class="version">
-                2.4.1
+                3.0.0
               </div>
 
 

docs/_modules/pycantonese/stop_words.html

@@ -7,7 +7,7 @@
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
 
-  <title>pycantonese.stop_words &mdash; PyCantonese 2.4.1 documentation</title>
+  <title>pycantonese.stop_words &mdash; PyCantonese 3.0.0 documentation</title>
 
 
 
@@ -61,7 +61,7 @@
 
 
               <div class="version">
-                2.4.1
+                3.0.0
               </div>
 
 

docs/_modules/pycantonese/word_segmentation.html

@@ -7,7 +7,7 @@
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
 
-  <title>pycantonese.word_segmentation &mdash; PyCantonese 2.4.1 documentation</title>
+  <title>pycantonese.word_segmentation &mdash; PyCantonese 3.0.0 documentation</title>
 
 
 
@@ -61,7 +61,7 @@
 
 
               <div class="version">
-                2.4.1
+                3.0.0
               </div>