haskal
/
kicad
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update compiling document Python scripting options. 

Change the default option setting for the Python scripting action menu
support.

Add notes that the KiCad scripting support is forcefully enable when the
Python scripting module support or the Python scripting action menu
support are enabled.
This commit is contained in:
Wayne Stambaugh 2019-06-05 14:00:57 -04:00
parent e75be4074e
commit c711ad5c7c
1 changed files with 9 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
Documentation/development/compiling.md
View File

@ -154,7 +154,8 @@ This options is enabled by default.
## Scripting Module Support ## {#scripting_mod_opt}
The KICAD_SCRIPTING_MODULES option is used to enable building and installing the Python modules
supplied by KiCad. This option is enabled by default.
supplied by KiCad. This option is enabled by default and it will enable
[KICAD_SCRIPTING](#scripting_opt) if disabled.
## Python 3 Scripting Support ## {#python3}
@ -171,6 +172,13 @@ Pcbnew including the wxPython console. This option is enabled by default.
The KICAD_SCRIPTING_WXPYTHON_PHOENIX option is used to enable building the wxPython interface with
the new Phoenix binding instead of the legacy one. This option is disabled by default.
## Python Scripting Action Menu Support ## {#python_action_menu_opt}
The KICAD_SCRIPTING_ACTION_MENU option allows Python scripts to be added directly to the Pcbnew
menu. This option is enabled by default and will enable [KICAD_SCRIPTING](#scripting_opt) if
disabled. Please note that this option is highly experimental and can cause Pcbnew to crash
if Python scripts create an invalid object state within Pcbnew.
## GitHub Plugin ## {#github_opt}
The BUILD_GITHUB_PLUGIN option is used to control if the GitHub plug in is built. This option is
@ -199,12 +207,6 @@ whether install them or not with the KICAD_INSTALL_DEMOS option. You can also se
install them with the KICAD_DEMOS variable. On Linux the demos are installed in
$PREFIX/share/kicad/demos by default.
## Python Scripting Action Menu Support ## {#python_action_menu_opt}
The KICAD_SCRIPTING_ACTION_MENU option allows Python scripts to be added directly to the Pcbnew
menu. This option is disabled by default. Please note that this option is highly experimental
and can cause Pcbnew to crash if Python scripts create an invalid object state within Pcbnew.
## Quality assurance (QA) unit tests ## {#quality_assurance_tests_opt}
The KICAD_BUILD_QA_TESTS option allows building unit tests binaries for quality assurance as part