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
Std FreeCADPowerUserHub


Description

The Std PythonHelp command starts a web server that communicates with the system's default Internet browser over a local socket. The web server displays information about the available Python modules, classes and functions of FreeCAD. The required pages are generated automatically.

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

Usage

  1. Select the Help → Std PythonHelp.svg Automatic python modules documentation option from the menu.
  2. Click on any of the links to go to the documentation of a specific class or function.