Include changelog in documentation (#177)

wntrblm · Apr 11, 2019 · 861e3cc · 861e3cc
1 parent 18b8e06
commit 861e3cc
Show file tree

Hide file tree

Showing 5 changed files with 7 additions and 1 deletion.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,5 @@
+# Changelog
+
 ## 2018.10.17
 
 - Fix bug where empty parametrized sessions would fail. (#151)

diff --git a/docs/CHANGELOG.md b/docs/CHANGELOG.md
@@ -0,0 +1 @@
+../CHANGELOG.md
diff --git a/docs/conf.py b/docs/conf.py
@@ -36,6 +36,7 @@
 extensions = [
     'sphinx.ext.autodoc',
     'sphinx.ext.napoleon',
+    'recommonmark',
 ]
 
 # Add any paths that contain templates here, relative to this directory.
@@ -44,7 +45,7 @@
 # The suffix(es) of source filenames.
 # You can specify multiple suffix as a list of string:
 # source_suffix = ['.rst', '.md']
-source_suffix = '.rst'
+source_suffix = ['.rst', '.md']
 
 # The encoding of source files.
 #source_encoding = 'utf-8-sig'

diff --git a/docs/index.rst b/docs/index.rst
@@ -9,6 +9,7 @@ Welcome to Nox
    config
    usage
    contrib
+   CHANGELOG
 
 ``nox`` is a command-line tool that automates testing in multiple Python environments, similar to `tox`_. Unlike tox, Nox uses a standard Python file for configuration.
 

diff --git a/requirements-test.txt b/requirements-test.txt
@@ -4,4 +4,5 @@ pytest-cov
 contexter
 sphinx
 sphinx-autobuild
+recommonmark
 witchhazel