From 6cab16be36c1397e98c24cbd77cec8c175d22834 Mon Sep 17 00:00:00 2001 From: Ayumu Ueha Date: Mon, 15 Nov 2021 13:55:23 +0000 Subject: [PATCH] Exclude db/types.py from sphinx-apidoc target SQLAlchemy 1.4.27 released on Nov 11, and tox-docs job error become to occur since then. `:ref:` attribute introduced from 1.4.27 in docstring of the parent class of our TypeDecorator cannot be referred. This patch fixes the error by excluding db/types.py from target of sphinx-apidoc. Change-Id: If7944774f2336d8f98124e9934da47b11801c607 --- doc/source/conf.py | 3 +++ 1 file changed, 3 insertions(+) diff --git a/doc/source/conf.py b/doc/source/conf.py index d86c70981..9f5a23c9a 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -49,6 +49,9 @@ apidoc_excluded_paths = [ 'vnfm/workflows', 'db/migration/alembic_migrations/*', 'db/migration/alembic_migrations', + # TODO(ueha): Excluding 'db/types.py' will be removed after the issue of + # TypeDecorator is fixed. + 'db/types.py', 'hacking'] apidoc_separate_modules = True