summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorWaylan Limberg <waylan.limberg@icloud.com>2018-10-25 10:16:19 -0400
committerWaylan Limberg <waylan.limberg@icloud.com>2018-10-25 10:43:40 -0400
commit7c78ac347b5dcad2be3d8d18b37ec33c96c1eb0b (patch)
tree9723e27cdddb2473cde79f85a1e5a156e1d15d48
parentd81207a6bd2a60c39b971baf789f8ac7fa912a21 (diff)
downloadpython-markdown-7c78ac347b5dcad2be3d8d18b37ec33c96c1eb0b.tar.gz
Create 3.1 release notes.
-rw-r--r--docs/change_log/index.md2
-rw-r--r--docs/change_log/release-3.0.md13
-rw-r--r--docs/change_log/release-3.1.md37
-rw-r--r--mkdocs.yml1
4 files changed, 47 insertions, 6 deletions
diff --git a/docs/change_log/index.md b/docs/change_log/index.md
index 5350b22..4d7a9b2 100644
--- a/docs/change_log/index.md
+++ b/docs/change_log/index.md
@@ -3,6 +3,8 @@ title: Change Log
Python-Markdown Change Log
=========================
+_______, 2018: Released version 3.1 ([Notes](release-3.1.md)).
+
Sept 28, 2018: Released version 3.0.1 (a bug-fix release).
* Brought back the `version` and `version_info` variables (#709).
diff --git a/docs/change_log/release-3.0.md b/docs/change_log/release-3.0.md
index 74a734f..7ed92fa 100644
--- a/docs/change_log/release-3.0.md
+++ b/docs/change_log/release-3.0.md
@@ -185,12 +185,13 @@ necessary and any extensions which expect the keyword will raise a
### `markdown.version` and `markdown.version_info` deprecated
-Historically, version numbers where acquired via the attributes `markdown.version`
-and `markdown.version_info`. Moving forward, a more standardized approach is being
-followed and versions are acquired via the `markdown.__version__` and
-`markdown.__version_info__` attributes. The legacy attributes are still available
-to allow distinguishing versions between the legacy Markdown 2.0 series and the
-Markdown 3.0 series, but in the future the legacy attributes will be removed.
+Historically, version numbers were acquired via the attributes
+`markdown.version` and `markdown.version_info`. Moving forward, a more
+standardized approach is being followed and versions are acquired via the
+`markdown.__version__` and `markdown.__version_info__` attributes. The legacy
+attributes are still available to allow distinguishing versions between the
+legacy Markdown 2.0 series and the Markdown 3.0 series, but in the future the
+legacy attributes will be removed.
### Added new, more flexible `InlineProcessor` class
diff --git a/docs/change_log/release-3.1.md b/docs/change_log/release-3.1.md
new file mode 100644
index 0000000..c05d70f
--- /dev/null
+++ b/docs/change_log/release-3.1.md
@@ -0,0 +1,37 @@
+title: Release Notes for v3.1
+
+# Python-Markdown 3.1 Release Notes
+
+Python-Markdown version 3.1 supports Python versions 2.7, 3.4, 3.5, 3.6, 3.7,
+PyPy and PyPy3.
+
+## Backwards-incompatible changes
+
+### `markdown.version` and `markdown.version_info` deprecated
+
+Historically, version numbers were acquired via the attributes
+`markdown.version` and `markdown.version_info`. As of 3.0, a more standardized
+approach is being followed and versions are acquired via the
+`markdown.__version__` and `markdown.__version_info__` attributes. As of 3.1
+the legacy attributes will raise a `DeprecationWarning` if they are accessed. In
+a future release the legacy attributes will be removed.
+
+## New features
+
+The following new features have been included in the release:
+
+* A [Contributing Guide](../contributing.md) has been added (#732).
+
+* A new configuration option to set the footnote separator has been added. Also,
+ the `rel` and `rev` attributes have been removed from footnotes as they are
+ not valid in HTML5. The `refs` and `backrefs` classes already exist and
+ serve the same purpose (#723).
+
+## Bug fixes
+
+The following bug fixes are included in the 3.1 release:
+
+* Version format had been updated to be PEP 440 compliant (#736).
+* Block level elements are defined per instance, not as class attributes
+ (#731).
+* Double escaping of block code has been eliminated (#725).
diff --git a/mkdocs.yml b/mkdocs.yml
index e01021e..448ce76 100644
--- a/mkdocs.yml
+++ b/mkdocs.yml
@@ -40,6 +40,7 @@ nav:
- Test Tools: test_tools.md
- Contributing to Python-Markdown: contributing.md
- Change Log: change_log/index.md
+ - Release Notes for v.3.1: change_log/release-3.1.md
- Release Notes for v.3.0: change_log/release-3.0.md
- Release Notes for v.2.6: change_log/release-2.6.md
- Release Notes for v.2.5: change_log/release-2.5.md