document doctest

collective · Oct 12, 2022 · 7b2e905 · 7b2e905
1 parent fb51485
commit 7b2e905
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 1 deletion.
diff --git a/CHANGES.rst b/CHANGES.rst
@@ -21,6 +21,7 @@ New features:
 
 - icalendar utility outputs a 'Duration' row
 - icalendar can take multiple ics files as an input
+- source code in documentation is tested using doctest #445 [niccokunzmann]
 
 Bug fixes:
 

diff --git a/docs/maintenance.rst b/docs/maintenance.rst
@@ -50,7 +50,10 @@ This explains how to create a new release on PyPI.
 You will need write access to the `PyPI project`_.
 
 1. Check that the ``CHANGES.rst`` is up to date with the latest merges and the version you want to release is correctly named.
-2. Change the ``__version__`` variable in the ``src/icalendar/__init__.py`` file.
+2. Change the ``__version__`` variable in
+
+   - the ``src/icalendar/__init__.py`` file and 
+   - in the ``docs/usage.rst`` file (look for ``icalendar.__version__``)
 3. Create a commit on the ``master`` branch to release this version.
 
     .. code-block:: bash