From 4d51f4a83a0965ba021170ee99063ac92b8d193e Mon Sep 17 00:00:00 2001
From: Francis Charette Migneault <francis.charette.migneault@gmail.com>
Date: Fri, 5 Jun 2020 10:16:50 -0400
Subject: [PATCH] add note about setting weaver.build_docs

---
 docs/source/conf.py | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/docs/source/conf.py b/docs/source/conf.py
index 395302d62..a94436dc4 100644
--- a/docs/source/conf.py
+++ b/docs/source/conf.py
@@ -83,6 +83,9 @@ def doc_redirect_include(file_path):
 })
 
 # generate openapi
+# note:
+#   setting 'weaver.build_docs' allows to ignore part of code that cause problem or require unnecessary
+#   configuration for the purpose of parsing the source to generate the OpenAPI
 config = Configurator(settings={"weaver.wps": False, "weaver.wps_restapi": True, "weaver.build_docs": True})
 config.include("weaver")  # need to include package to apply decorators and parse routes
 api_spec_file = os.path.join(DOC_BLD_ROOT, "api.json")