History

Ghanshyam Mann 8d18270863 Temporary exclude the common.sql.core.py from sphinx-apidoc target 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		2021-11-19 16:24:23 -06:00
..
ext	Replace support matrix ext with common library	2019-04-16 18:09:14 -07:00
source	Temporary exclude the common.sql.core.py from sphinx-apidoc target	2021-11-19 16:24:23 -06:00
Makefile	Align with project configs.	2012-03-01 11:42:42 -08:00
README.rst	Fixes documentation building	2013-12-13 02:47:37 +00:00
requirements.txt	Switch to newer openstackdocstheme and reno versions	2020-05-21 13:43:22 +00:00

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/.