ENH, DOC: add a chanelog system (#6)

* ENH, DOC: add a chanelog system

* FIX: add sphinxcrontrib-towncrier to doc deps

* FIX: install sphixcontrib-towncrier

docs/changes/devel.rst

@@ -0,0 +1,3 @@
+.. _current:
+
+.. towncrier-draft-entries:: Version |release| (development)

docs/changes/devel/6.newfeature.rst

@@ -0,0 +1,3 @@
+.. _Scott Huberty: https://github.com/scott-huberty
+
+Setup a changelog, using `towncrier <https://towncrier.readthedocs.io/en/stable/index.html>`_. by `Scott Huberty`_

docs/conf.py

@@ -3,6 +3,15 @@
 # For the full list of built-in configuration values, see the documentation:
 # https://www.sphinx-doc.org/en/master/usage/configuration.html
 
+from pathlib import Path
+
+# -- Path setup --------------------------------------------------------------
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+curpath = Path(__file__).parent.resolve(strict=True)
+
 # -- Project information -----------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
 
@@ -18,10 +27,11 @@
               "sphinx.ext.intersphinx",
               "sphinx.ext.todo",
               "sphinxemoji.sphinxemoji",
+              "sphinxcontrib.towncrier.ext",
               ]
 
 templates_path = ['_templates']
-exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store', "changes/devel"]
 
 
 
@@ -78,3 +88,7 @@
 }
 
 numpydoc_xref_ignore = {"of", "A",}
+
+# -- sphinxcontrib-towncrier configuration -----------------------------------
+
+towncrier_draft_working_directory = str(curpath.parent)

docs/index.rst

@@ -51,4 +51,5 @@ It copies much of the EDF (EyeLink Data Format) reading code.
    usage
    contributing
    API
-   roadmap
+   roadmap
+   whats_new

docs/whats_new.rst

@@ -0,0 +1,11 @@
+.. _whats_new:
+
+What's new
+==========
+
+Changes for each version of EyelinkIO are listed below.
+
+.. toctree::
+   :maxdepth: 1
+
+   ./changes/devel.rst

pyproject.toml

@@ -43,12 +43,13 @@ test = [
     "tomli; python_version<'3.11'",
 ]
 
-# Dependencies for building the docuemntation
+# Dependencies for building the documentation
 doc = [
     "sphinx>=6",
     "numpydoc",
     "pydata_sphinx_theme",
     "sphinxemoji",
+    "sphinxcontrib-towncrier",
 ]
 
 full = ["pandas", "mne"]
@@ -175,15 +176,10 @@ ignore_directives = [
 ]
 ignore_messages = "^.*(Unknown target name|Undefined substitution referenced)[^`]*$"
 
-[tool.mypy]
-ignore_errors = true
-scripts_are_modules = true
-strict = false
-
 [tool.towncrier]
 package = "eyelinkio"
-directory = "doc/changes/devel/"
-filename = "doc/changes/devel.rst"
+directory = "docs/changes/devel/"
+filename = "docs/changes/devel.rst"
 title_format = "{version} ({project_date})"
 issue_format = "`#{issue} <https://github.com/scott-huberty/eyelinkio/pulls/{issue}>`__"