diff --git a/docs/CHANGES.rst b/CHANGES.rst similarity index 99% rename from docs/CHANGES.rst rename to CHANGES.rst index 18d02d0..10a3d52 100644 --- a/docs/CHANGES.rst +++ b/CHANGES.rst @@ -1,7 +1,5 @@ -:orphan: - -Changes -======= +Changelog +========= 1.0.0-rc.3 (unreleased) ----------------------- diff --git a/docs/contribute/conventions.rst b/docs/contribute/conventions.rst index 526aecc..2379d98 100644 --- a/docs/contribute/conventions.rst +++ b/docs/contribute/conventions.rst @@ -340,12 +340,13 @@ on GitHub and with Sphinx. Tracking changes ================ -Feature-level changes to code are tracked inside ``docs/CHANGES.rst``. Example: +Feature-level changes to code are tracked inside ``CHANGES.rst``. The title +of the ``CHANGES.rst`` file should be ``Changelog``. Example: .. sourcecode:: rst - CHANGES - ======= + Changelog + ========= 1.0.0-dev (Unreleased) ---------------------- diff --git a/docs/contribute/index.rst b/docs/contribute/index.rst index 90af009..6135f1c 100644 --- a/docs/contribute/index.rst +++ b/docs/contribute/index.rst @@ -43,5 +43,4 @@ Description of our release process and guidelines. release.rst -.. include:: ../CHANGES.rst - :start-after: :orphan: +.. include:: ../../CHANGES.rst diff --git a/setup.py b/setup.py index 04f7416..7a86d86 100644 --- a/setup.py +++ b/setup.py @@ -8,7 +8,7 @@ def read(*rnames): long_description = \ read('README.rst') + \ - read('docs', 'CHANGES.rst') + \ + read('CHANGES.rst') + \ read('docs', 'LICENSE.txt') version = '1.0.0-rc.3'