From de7aff63b8bdb8d30f25db52d60a4889b9ffadd6 Mon Sep 17 00:00:00 2001 From: Boden R Date: Wed, 30 Nov 2016 15:07:46 -0700 Subject: [PATCH] Remove README from docs build Change [1] introduced a remote image link in our README.rst. Due to the fact that we include this README in our docs, our 'tox -e docs' build now fails due to the nonlocal image URI as we run the sphinx build with -W: -- Warning, treated as error: README.rst:None: WARNING: nonlocal image URI found: http://governance.openstack.org/badges/neutron-lib.svg -- Ignoring specific warnings is supported with newer versions of sphinx [2], but not with the version we currently use. Therefore this patch removes our readme reference from our doc/source/ tree. [1] https://review.openstack.org/#/c/402702/ [2] https://github.com/sphinx-doc/sphinx/issues/2466 Change-Id: I8458635f7081ea98a160cbb4105032d435bdcb98 --- doc/source/index.rst | 1 - doc/source/readme.rst | 1 - 2 files changed, 2 deletions(-) delete mode 100644 doc/source/readme.rst diff --git a/doc/source/index.rst b/doc/source/index.rst index 58b46c30d..c6a452149 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -45,7 +45,6 @@ Programming HowTos and Tutorials .. toctree:: :maxdepth: 3 - readme conventions installation usage diff --git a/doc/source/readme.rst b/doc/source/readme.rst deleted file mode 100644 index a6210d3d8..000000000 --- a/doc/source/readme.rst +++ /dev/null @@ -1 +0,0 @@ -.. include:: ../../README.rst