With the new release of SQLAlchemy(1.4.27) TypeDecorator used in common/sql/core.py file started failing (below error). I am not sure if it is valid issue in SQLAlchemy or in our code base and we need to blacklist the SQLAlchemy 1.4.27 version in requirements. But to unblock the gate let's exclude it from sphinx-apidoc target. Error: Warning, treated as error: /opt/stack/keystone/keystone/common/sql/core.py:docstring of keystone.common.sql.core.DateTimeInt.process_bind_param:19:undefined label: types_typedecorator -https: //zuul.opendev.org/t/openstack/build/b2ee464fa1554cb89dc8873486865151 Change-Id: I7de055c2b266430bf886e200c3d8829a48ae9600
Building Docs
Developer documentation is generated using Sphinx. To build this documentation, run the following from the root of the repository:
$ tox -e docs
The documentation will be built at doc/build/.