add note about setting weaver.build_docs

crim-ca · Jun 5, 2020 · 4d51f4a · 4d51f4a
1 parent 2058536
commit 4d51f4a
Showing 1 changed file with 3 additions and 0 deletions.
diff --git 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")