docs: One file to rule them all for the changelog (#1282)

cobrateam · May 29, 2024 · 8c49f2d · 8c49f2d
1 parent ba59e01
commit 8c49f2d
Show file tree

Hide file tree

Showing 52 changed files with 730 additions and 1,049 deletions.
diff --git a/CHANGELOG.rst b/CHANGELOG.rst
diff --git a/README.rst b/README.rst
@@ -23,7 +23,7 @@ Splinter is a Python framework that provides a simple and consistent interface f
 
 * `Documentation <https://splinter.readthedocs.io>`_
 
-* `Changelog <https://splinter.readthedocs.io/en/latest/news.html>`_
+* `Changelog <https://splinter.readthedocs.io/en/latest/changelog.html>`_
 
 Key features:
 

diff --git a/docs/changelog.rst b/docs/changelog.rst
@@ -0,0 +1,9 @@
+.. meta::
+    :description: Splinter Changelog
+    :keywords: splinter, python, news, documentation, tutorial, changelog, web application
+
++++++++++
+Changelog
++++++++++
+
+.. include:: ../CHANGELOG.rst
diff --git a/docs/index.rst b/docs/index.rst
@@ -13,7 +13,7 @@
   :hidden:
 
   why
-  news
+  changelog
   tutorial
 
 .. toctree::

diff --git a/docs/news.rst b/docs/news.rst
@@ -1,18 +1,16 @@
+.. NOTE: This file is kept for legacy purposes. 3rd party sites may be linking to news.html
+   The changelog used to be multiple separate files linked from this file.
+
 .. Copyright 2014 splinter authors. All rights reserved.
    Use of this source code is governed by a BSD-style
    license that can be found in the LICENSE file.
 
 .. meta::
-    :description: New splinter features on earlier versions.
+    :description: Splinter Changelog
     :keywords: splinter, python, news, documentation, tutorial, changelog, web application
 
 +++++++++
 Changelog
 +++++++++
 
-.. toctree::
-    :glob:
-    :reversed:
-    :maxdepth: 1
-
-    news/*
+.. include:: ../CHANGELOG.rst
diff --git a/docs/news/0.0.1.rst b/docs/news/0.0.1.rst
diff --git a/docs/news/0.0.2.rst b/docs/news/0.0.2.rst
diff --git a/docs/news/0.0.3.rst b/docs/news/0.0.3.rst
diff --git a/docs/news/0.01.0.rst b/docs/news/0.01.0.rst
diff --git a/docs/news/0.01.1.rst b/docs/news/0.01.1.rst
diff --git a/docs/news/0.02.0.rst b/docs/news/0.02.0.rst
diff --git a/docs/news/0.03.0.rst b/docs/news/0.03.0.rst
diff --git a/docs/news/0.04.0.rst b/docs/news/0.04.0.rst
diff --git a/docs/news/0.04.01.rst b/docs/news/0.04.01.rst
diff --git a/docs/news/0.04.02.rst b/docs/news/0.04.02.rst
diff --git a/docs/news/0.04.03.rst b/docs/news/0.04.03.rst
diff --git a/docs/news/0.04.04.01.rst b/docs/news/0.04.04.01.rst