Skip to content

Commit

Permalink
Remove README from docs build
Browse files Browse the repository at this point in the history
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] sphinx-doc/sphinx#2466

Change-Id: I8458635f7081ea98a160cbb4105032d435bdcb98
  • Loading branch information
bodenr committed Nov 30, 2016
1 parent 6d893c8 commit de7aff6
Show file tree
Hide file tree
Showing 2 changed files with 0 additions and 2 deletions.
1 change: 0 additions & 1 deletion doc/source/index.rst
Expand Up @@ -45,7 +45,6 @@ Programming HowTos and Tutorials
.. toctree::
:maxdepth: 3

readme
conventions
installation
usage
Expand Down
1 change: 0 additions & 1 deletion doc/source/readme.rst

This file was deleted.

0 comments on commit de7aff6

Please sign in to comment.