Std PythonHelp: Difference between revisions

From FreeCAD Documentation
(Revised. Added Docnav.)
No edit summary
 
(3 intermediate revisions by 2 users not shown)
Line 2: Line 2:
<translate>
<translate>


<!--T:8-->
{{Docnav
{{Docnav
|[[Std_FreeCADPowerUserHub|Std FreeCADPowerUserHub]]
|[[Std_FreeCADPowerUserHub|FreeCADPowerUserHub]]
|[[Std_FreeCADForum|Std FreeCADForum]]
|[[Std_FreeCADForum|FreeCADForum]]
|[[Std_Help_Menu|Std Help Menu]]
|[[Std_Help_Menu|Std Help Menu]]
|IconL=Std_FreeCADPowerUserHub.svg
|IconL=Std_FreeCADPowerUserHub.svg
Line 22: Line 23:


<!--T:3-->
<!--T:3-->
The '''Std PythonHelp''' command starts a web server that communicates with the system's default Internet browser over a local socket. The page that opens displays the available [[Python|Python]] modules, classes and functions of FreeCAD. The required pages are generated automatically.
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|Python]] modules, classes and functions of FreeCAD. The required pages are generated automatically.


<!--T:4-->
<!--T:4-->
Line 31: Line 32:
<!--T:6-->
<!--T:6-->
# Select the {{MenuCommand|Help → [[Image:Std_PythonHelp.svg|16px]] Automatic python modules documentation}} option from the menu.
# Select the {{MenuCommand|Help → [[Image:Std_PythonHelp.svg|16px]] Automatic python modules documentation}} option from the menu.
# Click on any of the links to go to the documentation of specific class or function.
# Click on any of the links to go to the documentation of a specific class or function.


<!--T:9-->
{{Docnav
{{Docnav
|[[Std_FreeCADPowerUserHub|Std FreeCADPowerUserHub]]
|[[Std_FreeCADPowerUserHub|FreeCADPowerUserHub]]
|[[Std_FreeCADForum|Std FreeCADForum]]
|[[Std_FreeCADForum|FreeCADForum]]
|[[Std_Help_Menu|Std Help Menu]]
|[[Std_Help_Menu|Std Help Menu]]
|IconL=Std_FreeCADPowerUserHub.svg
|IconL=Std_FreeCADPowerUserHub.svg

Latest revision as of 21:03, 22 December 2020

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