openstack/neutron-lib
Code Issues Proposed changes
neutron-lib/doc/source/index.rst
skrobul d69eae326e
Fix python modules docs build 
Currently the Python code documentation is not being published at all
which can be observed by visiting

https://docs.openstack.org/neutron-lib/latest/genindex.html

This used to work in the old versions, for example in 1.9.1:

https: //docs.openstack.org/neutron-lib/1.9.1/genindex.html

Docstring fixes in placement/utils.py:

When Sphinx generates documentation, it produces following warning:
"WARNING: Definition list ends without a blank line; unexpected unindent.""

This commit adds the missing lines, but also switches to :: so that
contents of the definitions are treated as raw text.

Change-Id: Ibb919c53d7e1bc2710e85ae86a0ed0d7620a900c
2024-08-15 14:26:52 +01:00

2.0 KiB
Raw Permalink Blame History

Welcome to Neutron Lib 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. If not, hop over to the OpenStack doc site

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!

install/index user/index contributor/index

html

reference/index Package Reference <reference/modules/modules>