Std PythonHelp

From FreeCAD Documentation
Jump to navigation Jump to search
Other languages:
English • ‎français • ‎italiano • ‎русский

Std PythonHelp.svg Std PythonHelp

Menu location
Help → Automatic Python modules documentation
Workbenches
All
Default shortcut
None
Introduced in version
-
See also
Online help, Power user hub, Help menu


Description

Std PythonHelp starts a web server that communicates with your default browser over a local socket. The page that opens displays the available Python modules, classes and functions of FreeCAD; the different pages are generated in the background automatically.

This web server is based on Python's pydoc module, and thus it extracts the docstrings of Python files (.py), and textual documentation defined in the Python wrappers (.xml) which expose the underlying C++ code.

Usage

  1. Open the menu HelpStd PythonHelp.svg Automatic Python modules documentation
  2. Click on any of the links to go to the specific class or function documentation.