Remove CHANGELOG from API documentation

This removes the dep on m2r2, and closes #162.
SethMMorton · Apr 19, 2023 · 3b161be · 3b161be
1 parent 7df66a2
commit 3b161be
Show file tree

Hide file tree

Showing 7 changed files with 8 additions and 16 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,6 +1,11 @@
 Unreleased
 ---
 
+### Changed
+
+- The changelog now only explictly exists in the repository
+  (issue [#162](https://github.com/SethMMorton/natsort/issues/162))
+
 [8.3.1] - 2023-03-01
 ---
 

diff --git a/README.rst b/README.rst
@@ -471,7 +471,7 @@ Seth M. Morton
 History
 -------
 
-Please visit the changelog `on GitHub`_ or `in the documentation`_.
+Please visit the changelog `on GitHub`_.
 
 .. _natsort: https://natsort.readthedocs.io/en/stable/index.html
 .. _natsorted(): https://natsort.readthedocs.io/en/stable/api.html#natsort.natsorted
@@ -500,7 +500,6 @@ Please visit the changelog `on GitHub`_ or `in the documentation`_.
 .. _How Does Natsort Work?: https://github.com/SethMMorton/natsort/wiki/How-Does-Natsort-Work%3F
 .. _API: https://natsort.readthedocs.io/en/stable/api.html
 .. _on GitHub: https://github.com/SethMMorton/natsort/blob/main/CHANGELOG.md
-.. _in the documentation: https://natsort.readthedocs.io/en/stable/changelog.html
 .. _file an issue: https://github.com/SethMMorton/natsort/issues/new
 .. _look at this issue describing how to debug: https://github.com/SethMMorton/natsort/issues/13#issuecomment-50422375
 .. _controlling the case-sensitivity: https://github.com/SethMMorton/natsort/wiki/Examples-and-Recipes#controlling-case-when-sorting

diff --git a/docs/changelog.rst b/docs/changelog.rst
@@ -3,4 +3,4 @@
 Changelog
 =========
 
-.. mdinclude:: ../CHANGELOG.md
+Please visit https://github.com/SethMMorton/natsort/blob/main/CHANGELOG.md.
diff --git a/docs/conf.py b/docs/conf.py
@@ -33,15 +33,14 @@
     "sphinx.ext.intersphinx",
     "sphinx.ext.mathjax",
     "sphinx.ext.napoleon",
-    "m2r2",
 ]
 autodoc_typehints = "none"
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ["_templates"]
 
 # The suffix of source filenames.
-source_suffix = [".rst", ".md"]
+source_suffix = [".rst"]
 
 # The encoding of source files.
 # source_encoding = 'utf-8-sig'

diff --git a/docs/requirements.in b/docs/requirements.in
diff --git a/docs/requirements.txt b/docs/requirements.txt
diff --git a/tox.ini b/tox.ini
@@ -72,7 +72,6 @@ skip_install = true
 deps =
     sphinx
     sphinx_rtd_theme
-    -r docs/requirements.txt
 commands =
     {envpython} setup.py build_sphinx
 skip_install = true