Std PythonHelp: Difference between revisions

From FreeCAD Documentation
(Automatic Python modules documentation)
 
No edit summary
 
(13 intermediate revisions by 4 users not shown)
Line 2: Line 2:
<translate>
<translate>


<!--T:8-->
{{Docnav
|[[Std_FreeCADPowerUserHub|FreeCADPowerUserHub]]
|[[Std_FreeCADForum|FreeCADForum]]
|[[Std_Help_Menu|Std Help Menu]]
|IconL=Std_FreeCADPowerUserHub.svg
|IconR=Std_FreeCADForum.svg
|IconC=Freecad.svg
}}

<!--T:1-->
{{GuiCommand
{{GuiCommand
|Name=Std PythonHelp
|Name=Std PythonHelp
|MenuLocation=[[Std Help Menu|Help]] → Automatic Python modules documentation
|MenuLocation=Help → Automatic python modules documentation
|Workbenches=All
|Workbenches=All
|SeeAlso=[[Std_FreeCADPowerUserHub|Std FreeCADPowerUserHub]]
|SeeAlso=[[Std_Help_Menu|Help menu]], [[Std WhatsThis|What's This?]], [[Std_FreeCADUserHub|Users documentation]]
}}
}}


==Description==
==Description== <!--T:2-->


<!--T:3-->
Opens a web browser window with a small server that shows the documentation for the Python classes and their functions in the software.
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-->
==How to use==
The web server is based on Python's [https://docs.python.org/3.8/library/pydoc.html#module-pydoc pydoc] module, and thus extracts the docstrings of Python files ({{incode|.py}}), and textual documentation defined in the Python wrappers ({{incode|.xml}}) which expose the underlying C++ code.


==Usage== <!--T:5-->
# Open the menu {{MenuCommand|[[Std_Help_Menu|Help]] → [[File:Std_PythonHelp.svg|16px]] [[Std_PythonHelp|Automatic Python modules documentation]]}}

# Click on any of the links to go to the specific class or function documentation.
<!--T:6-->
# 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 a specific class or function.

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


{{Std_Base}}
{{Userdocnavi}}
</translate>
</translate>
{{Std Base navi{{#translation:}}}}
{{Userdocnavi{{#translation:}}}}
{{clear}}
{{clear}}

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.