From 8482fad4ff256d4d1722db2d7b9a4fd09ab7789c Mon Sep 17 00:00:00 2001 From: Joshua Harlow Date: Thu, 24 Sep 2015 13:20:14 -0700 Subject: [PATCH] Include changelog/history in docs Change-Id: Ic68fc583338c48f829cd36c21e1c2fe654022bf5 --- doc/source/history.rst | 1 + doc/source/index.rst | 8 ++++++++ tox.ini | 8 +++----- 3 files changed, 12 insertions(+), 5 deletions(-) create mode 100644 doc/source/history.rst diff --git a/doc/source/history.rst b/doc/source/history.rst new file mode 100644 index 00000000..69ed4fe6 --- /dev/null +++ b/doc/source/history.rst @@ -0,0 +1 @@ +.. include:: ../../ChangeLog diff --git a/doc/source/index.rst b/doc/source/index.rst index ac2d25da..8bb1c840 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -18,6 +18,14 @@ Contents tutorial/index developers +Release Notes +============= + +.. toctree:: + :maxdepth: 1 + + history + Indices and tables ================== diff --git a/tox.ini b/tox.ini index d764076a..ac6039ee 100644 --- a/tox.ini +++ b/tox.ini @@ -63,8 +63,8 @@ commands = {toxinidir}/setup-mysql-env.sh python setup.py testr --slowest --test commands = python setup.py testr --slowest --coverage --testr-args="{posargs}" [testenv:docs] -commands = doc8 doc/source - python setup.py build_sphinx +commands = python setup.py build_sphinx + doc8 doc/source [testenv:pep8] commands = @@ -81,6 +81,4 @@ import_exceptions = six.moves [doc8] -# This path is pretty much all automatically generated, and has really -# long lines, so just ignore it.... -ignore-path = doc/source/compatibility.rst +ignore-path = doc/source/compatibility.rst,doc/source/history.rst