Python Code

This page is created automatically from Python scripts contained in GDA source, for details see How this page is auto-generated at end of page.

---

During execution of script extractPyDocs.py, used to auto-generate contents of this page, no Python scripts were found. The most common cause of this is no environment variable $WORKSPACE being set prior to executing make html (that during processing calls the extractPyDocs.py script). The contents of the GDA source Gerrit repositories are expected to be found by the script under $WORKSPACE/materialize_workspace_git. This is the default location used as this is the location used by the Jenkins job GDA.master-documentation.manuals, which is responsible for the nightly build of the documentation.

If $WORKSPACE environment variable is not set when the script is executed the location of the GDA source is set to the parent directory of the current workspace where the GDA documentation source is located.

---

How this page is auto-generated

The contents of this page are automatically generated on each build of the GDA Developer Guide documentation. This is achieved by the documentation’s make target html executing scripts/extractPyDocs.py, prior to building the html files from document sources. See the GDA Developer Guide Makefile targets - html section of this document for details.