de7aff63b8
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
2.1 KiB
Welcome to Neutron Lib developer documentation!
Neutron-lib is an OpenStack library project used by Neutron, Advanced Services, and third-party projects that aims to provide common functionality across all such consumers. The library is developed with the following goals in mind:
- Decouple sub-projects from Neutron (i.e. no direct neutron imports in sub-projects).
- Pay down Neutron technical debt via refactoring/re-architecting of sub-optimal patterns in their respective neutron-lib implementation.
This document describes the library for contributors of the project, and assumes that you are already familiar with Neutron from an end-user perspective.
This documentation is generated by the Sphinx toolkit and lives in the source tree. Additional documentation on Neutron and other components of OpenStack can be found on the OpenStack wiki and the Neutron section of the wiki. The Neutron Development wiki is also a good resource for new contributors.
Enjoy!
Programming HowTos and Tutorials
conventions installation usage review-guidelines contributing releasing
Developer Docs
devref/index