stop using reno to manage release notes

Without branches, reno is proving to be more trouble than it's worth. Let's manage release notes by hand. Signed-off-by: Doug Hellmann <doug@doughellmann.com>
sphinx-contrib · Oct 18, 2020 · ba98010 · ba98010
1 parent a0a1b72
commit ba98010
Show file tree

Hide file tree

Showing 10 changed files with 56 additions and 53 deletions.
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -24,7 +24,6 @@
 # Add any Sphinx extension module names here, as strings. They can be extensions
 # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
 extensions = [
-    'reno.sphinxext',
     'sphinxcontrib.spelling',
 ]
 

diff --git a/docs/source/history.rst b/docs/source/history.rst
@@ -6,7 +6,62 @@
 
    unmaintained
 
-.. release-notes::
+5.4.0
+=====
+
+New Features
+------------
+
+- Added a new filter
+  (``sphinxcontrib.spelling.filters.ContributorFilter``) that treats
+  contributor names extracted from the git history as spelled
+  correctly, making it easier to refer to the names in
+  acknowledgments . Includes a new configuration option,
+  ``spelling_ignore_contributor_names`` to enable it.
+
+5.3.0
+=====
+
+New Features
+------------
+
+- Add a configuration option ``spelling_exclude_patterns`` to manage
+  skipping spell checking for some input files. The option uses a
+  list of glob-style patterns that are matched against the source
+  file names relative to the source directory. See :doc:`/customize`
+  for more details. Contributed by sdelliot.
+
+5.2.2
+=====
+
+Bug Fixes
+---------
+
+- Updated to only create ``.spelling`` output files for inputs that
+  generate spelling warnings. Fixes #63.
+
+5.2.0
+=====
+
+New Features
+------------
+
+- The builder is now registered using an entry point, so that if the
+  ``spelling`` directive is not used in a project
+  ``sphinxcontrib.spelling`` does not need to be included explicitly
+  in the ``extensions`` list in ``conf.py`` in order to use it with
+  the project on the command line.
+
+- PyEnchant is an optional dependency. If it is not installed, the
+  spell checker will not work, but the extension can still be
+  initialized. This allows projects that use spell checking to
+  publish their documentation to ``readthedocs.org``, where it is
+  not possible to install PyEnchant.
+
+- Restore support for parallel builds. Words that do not appear in
+  any configured dictionary are written to a file named based on the
+  input file, with the ``.rst`` extension replaced with
+  ``.spelling``.
 
 5.1.2
 =====

diff --git a/releasenotes/notes/clean-output-7a62ee4e7f6f817d.yaml b/releasenotes/notes/clean-output-7a62ee4e7f6f817d.yaml
diff --git a/releasenotes/notes/contributor-name-filter-60f6f5014b292977.yaml b/releasenotes/notes/contributor-name-filter-60f6f5014b292977.yaml
diff --git a/releasenotes/notes/entry-point-b2ad290cd46d055c.yaml b/releasenotes/notes/entry-point-b2ad290cd46d055c.yaml
diff --git a/releasenotes/notes/exclude-patterns-83910a7f02407597.yaml b/releasenotes/notes/exclude-patterns-83910a7f02407597.yaml
diff --git a/releasenotes/notes/optional-pyenchant-76a049d1d6104cfb.yaml b/releasenotes/notes/optional-pyenchant-76a049d1d6104cfb.yaml
diff --git a/releasenotes/notes/parallel-builds-ea64713dd82a4498.yaml b/releasenotes/notes/parallel-builds-ea64713dd82a4498.yaml
diff --git a/releasenotes/notes/use-reno-761465ea58eb5f49.yaml b/releasenotes/notes/use-reno-761465ea58eb5f49.yaml
diff --git a/setup.cfg b/setup.cfg
@@ -41,8 +41,6 @@ test =
     coverage!=4.4,>=4.0
 linter =
     flake8==3.8.2
-docs =
-    reno
 
 [entry_points]
 sphinx.builders =