Move changelog to docs

CHANGES.rst

@@ -1,116 +1 @@
-Version x.y.z (unreleased)
-==========================
-
-Release date: the-future
-
-New features
-------------
-- Add additional metadata to docker images about how they were built `#500`_ by
-  `@jrbourbeau`_.
-
-API changes
------------
-
-Bug fixes
----------
-
-
-Version 0.7.0
-=============
-
-Release date: 2018-12-12
-
-New features
-------------
-
-- Build from sub-directory: build the image based on a sub-directory of a
-  repository `#413`_ by `@dsludwig`_.
-- Editable mode: allows editing a local repository from a live container
-  `#421`_ by `@evertrol`_.
-- Change log added `#426`_ by `@evertrol`_.
-- Documentation: improved the documentation for contributors `#453`_ by
-  `@choldgraf`_.
-- Buildpack: added support for the nix package manager `#407`_ by
-  `@costrouc`_.
-- Log a 'success' message when push is complete `#482`_ by
-  `@yuvipanda`_.
-- Allow specifying images to reuse cache from `#478`_ by
-  `@yuvipanda`_.
-- Add JupyterHub back to base environment `#467`_ by
-  `@yuvipanda`_.
-- Repo2docker has a logo! by `@agahkarakuzu`_ and `@blairhudson`_.
-- Improve support for Stencila, including identifying stencila runtime from document context `#457`_ by `@nuest`_.
-
-
-API changes
------------
-
-- Add content provider abstraction `#421`_ by `@betatim`_.
-
-
-Bug fixes
----------
-
-- Update to Jupyter notebook 5.7 `#475`_ by `@betatim`_ and `@minrk`_
-
-
-
-Version 0.6
-===========
-
-Released 2018-09-09
-
-
-Version 0.5
-===========
-
-Released 2018-02-07
-
-
-Version 0.4.1
-=============
-
-Released 2018-09-06
-
-
-Version 0.2
-===========
-
-Released 2018-05-25
-
-
-Version 0.1.1
-=============
-
-Released 2017-04-19
-
-
-Version 0.1
-===========
-
-Released 2017-04-14
-
-
-.. _#242: https://github.com/jupyter/repo2docker/pull/242
-.. _#407: https://github.com/jupyter/repo2docker/pull/407
-.. _#413: https://github.com/jupyter/repo2docker/pull/413
-.. _#421: https://github.com/jupyter/repo2docker/pull/421
-.. _#426: https://github.com/jupyter/repo2docker/pull/426
-.. _#453: https://github.com/jupyter/repo2docker/pull/453
-.. _#457: https://github.com/jupyter/repo2docker/pull/457
-.. _#475: https://github.com/jupyter/repo2docker/pull/475
-.. _#478: https://github.com/jupyter/repo2docker/pull/478
-.. _#482: https://github.com/jupyter/repo2docker/pull/482
-.. _#500: https://github.com/jupyter/repo2docker/pull/500
-
-.. _@agahkarakuzu: https://github.com/agahkarakuzu
-.. _@betatim: https://github.com/betatim
-.. _@blairhudson: https://github.com/blairhudson
-.. _@choldgraf: https://github.com/choldgraf
-.. _@costrouc: https://github.com/costrouc
-.. _@dsludwig: https://github.com/dsludwig
-.. _@evertrol: https://github.com/evertrol
-.. _@jrbourbeau: https://github.com/jrbourbeau
-.. _@minrk: https://github.com/minrk
-.. _@nuest: https://github.com/nuest
-.. _@yuvipanda: https://github.com/yuvipanda
+The ``repo2docker`` changelog has been moved to https://repo2docker.readthedocs.io/en/latest/changelog.html

docs/source/changelog.rst

@@ -0,0 +1,108 @@
+=========
+Changelog
+=========
+
+
+Upcoming release
+================
+
+Release date: TBD
+
+New features
+------------
+- Add additional metadata to docker images about how they were built :pr:`500` by
+  `@jrbourbeau`_.
+
+API changes
+-----------
+
+Bug fixes
+---------
+
+
+Version 0.7.0
+=============
+
+Release date: 2018-12-12
+
+New features
+------------
+
+- Build from sub-directory: build the image based on a sub-directory of a
+  repository :pr:`413` by `@dsludwig`_.
+- Editable mode: allows editing a local repository from a live container
+  :pr:`421` by `@evertrol`_.
+- Change log added :pr:`426` by `@evertrol`_.
+- Documentation: improved the documentation for contributors :pr:`453` by
+  `@choldgraf`_.
+- Buildpack: added support for the nix package manager :pr:`407` by
+  `@costrouc`_.
+- Log a 'success' message when push is complete :pr:`482` by
+  `@yuvipanda`_.
+- Allow specifying images to reuse cache from :pr:`478` by
+  `@yuvipanda`_.
+- Add JupyterHub back to base environment :pr:`476` by `@yuvipanda`_.
+- Repo2docker has a logo! by `@agahkarakuzu`_ and `@blairhudson`_.
+- Improve support for Stencila, including identifying stencila runtime from document context :pr:`457` by `@nuest`_.
+
+
+API changes
+-----------
+
+- Add content provider abstraction :pr:`421` by `@betatim`_.
+
+
+Bug fixes
+---------
+
+- Update to Jupyter notebook 5.7 :pr:`475` by `@betatim`_ and `@minrk`_
+
+
+
+Version 0.6
+===========
+
+Released 2018-09-09
+
+
+Version 0.5
+===========
+
+Released 2018-02-07
+
+
+Version 0.4.1
+=============
+
+Released 2018-09-06
+
+
+Version 0.2
+===========
+
+Released 2018-05-25
+
+
+Version 0.1.1
+=============
+
+Released 2017-04-19
+
+
+Version 0.1
+===========
+
+Released 2017-04-14
+
+
+.. _@agahkarakuzu: https://github.com/agahkarakuzu
+.. _@betatim: https://github.com/betatim
+.. _@blairhudson: https://github.com/blairhudson
+.. _@choldgraf: https://github.com/choldgraf
+.. _@costrouc: https://github.com/costrouc
+.. _@dsludwig: https://github.com/dsludwig
+.. _@evertrol: https://github.com/evertrol
+.. _@jrbourbeau: https://github.com/jrbourbeau
+.. _@minrk: https://github.com/minrk
+.. _@nuest: https://github.com/nuest
+.. _@yuvipanda: https://github.com/yuvipanda

docs/source/conf.py

@@ -33,7 +33,12 @@
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
-extensions = []
+extensions = ['sphinx.ext.extlinks']
+
+extlinks = {
+    'issue': ('https://github.com/jupyter/repo2docker/issues/%s', 'Issue #'),
+    'pr': ('https://github.com/jupyter/repo2docker/pull/%s', 'PR #')
+}
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']

docs/source/contributing/contributing.md

@@ -10,7 +10,7 @@ repo2docker merged.
   community is a great way to save time later.
 * Make edits in your fork of the repo2docker repository
 * Submit a pull request (this is how all changes are made)
-* Edit [the changelog](https://github.com/jupyter/repo2docker/blob/master/CHANGES.rst)
+* Edit [the changelog](./../../changelog.html)
   by appending your feature / bug fix to the development version.
 * Wait for a community member to merge your changes
 * (optional) Deploy a new version of repo2docker to mybinder.org by [following these steps](http://mybinder-sre.readthedocs.io/en/latest/deployment/how.html)

docs/source/index.rst

@@ -48,3 +48,9 @@ Please report `Bugs <https://github.com/jupyter/repo2docker/issues>`_,
    design
    contributing/tasks
    contributing/buildpack
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Changelog
+
+   changelog