From f5a3b017b72179f75247059163d1de7fc7567367 Mon Sep 17 00:00:00 2001 From: Kaxil Naik Date: Wed, 16 Mar 2022 00:17:24 +0000 Subject: [PATCH] Docs: Ignore Example DAGs from API reference Example DAGs don't define any classes so it does not make sense to include them in the docs --- docs/conf.py | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/docs/conf.py b/docs/conf.py index 16dcc7776..6fdcd4309 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -85,7 +85,7 @@ # html_static_path = ["_static"] # -- AutoAPI --------------------------------------------------------------- -autoapi_dirs = [str(prov_dir) for prov_dir in Path("../astronomer/providers/").iterdir()] +autoapi_dirs = sorted([str(prov_dir) for prov_dir in Path("../astronomer/providers/").iterdir()]) autoapi_generate_api_docs = True @@ -118,6 +118,11 @@ "special-members", ] +# Ignore example DAGs from the API docs +autoapi_ignore = [ + "*example_dags*", +] + suppress_warnings = [ "autoapi.python_import_resolution", "ref.doc",