Std PythonHelp: Difference between revisions

From FreeCAD Documentation
No edit summary
No edit summary
 
(4 intermediate revisions by 2 users not shown)
Line 1: Line 1:
<languages/>
<languages/>
<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-->
<!--T:1-->
{{GuiCommand
{{GuiCommand
|Name=Std PythonHelp
|Name=Std PythonHelp
|MenuLocation={{StdMenu|[[Std Help Menu|Help]]}} → Automatic Python modules documentation
|MenuLocation=Help → Automatic python modules documentation
|Workbenches=All
|Workbenches=All
|SeeAlso=[[Std_OnlineHelp|Online help]], [[Std_FreeCADPowerUserHub|Power user hub]], [[Std_Help_Menu|Help menu]]
|SeeAlso=[[Std_FreeCADPowerUserHub|Std FreeCADPowerUserHub]]
}}
}}


Line 13: Line 23:


<!--T:3-->
<!--T:3-->
[[Std_PythonHelp|Std PythonHelp]] starts a web server that communicates with your default browser over a local socket. The page that opens displays the available [[Python|Python]] modules, classes and functions of FreeCAD; the different pages are generated in the background 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-->
This web server is based on Python's [https://docs.python.org/3.8/library/pydoc.html#module-pydoc pydoc] module, and thus it extracts the docstrings of Python files ({{incode|.py}}), and textual documentation defined in the Python wrappers ({{incode|.xml}}) which expose the underlying C++ code.
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-->
==Usage== <!--T:5-->


<!--T:6-->
<!--T:6-->
# Open the menu {{MenuCommand|{{StdMenu|[[Std_Help_Menu|Help]]}} → [[File:Std_PythonHelp.svg|16px]] [[Std_PythonHelp|Automatic Python modules documentation]]}}
# 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 specific class or function documentation.
# 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
}}


</translate>
</translate>

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.