From bcdec1acfa0286a865312b0b3def49076ccb81c4 Mon Sep 17 00:00:00 2001 From: Colleen Murphy Date: Thu, 24 May 2018 13:35:31 -0700 Subject: [PATCH] Don't rely on pbr ChangeLog for docs The ChangeLog file is generated when we run `python setup.py sdist`, which doesn't naturally happen when we run `tox -edocs`, so on a fresh clone the docs build will fail because it references the ChangeLog file which isn't there. Since we don't rely on pbr any more for release notes and we have a sophisticated release note management tool, point the docs at the published release notes instead of the pbr ChangeLog. Change-Id: I614091eae739154337795a8f120b68686ad0ed0a --- doc/source/history.rst | 1 - doc/source/index.rst | 5 ++--- 2 files changed, 2 insertions(+), 4 deletions(-) delete mode 100644 doc/source/history.rst diff --git a/doc/source/history.rst b/doc/source/history.rst deleted file mode 100644 index 69ed4fe6..00000000 --- a/doc/source/history.rst +++ /dev/null @@ -1 +0,0 @@ -.. include:: ../../ChangeLog diff --git a/doc/source/index.rst b/doc/source/index.rst index 66b851d1..4ce81f0d 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -28,10 +28,9 @@ API, the Keystone team also provides `Identity Service`_, as well as Release Notes ============= -.. toctree:: - :maxdepth: 1 +`Release Notes`_ - history +.. _Release Notes: https://docs.openstack.org/releasenotes/keystonemiddleware/ Contributing ============