Skip to content

Latest commit

 

History

History
30 lines (17 loc) · 1.08 KB

Std_PythonHelp.md

File metadata and controls

30 lines (17 loc) · 1.08 KB
GuiCommand
Name MenuLocation Workbenches SeeAlso
Std PythonHelp
Help , Automatic python modules documentation
All
Std_FreeCADPowerUserHub

Std PythonHelp

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 → 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.

{{Std Base navi}}


documentation index > Std PythonHelp