Std PythonHelp: Difference between revisions

From FreeCAD Documentation
(Automatic Python modules documentation)
 
(The page that opens displays the available Python modules, classes and functions of FreeCAD; the different pages are generated in the background automatically.)
Line 11: Line 11:
==Description==
==Description==


Opens a web browser window with a small server that shows the documentation for the Python classes and their functions in the software.
[[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.

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.


==How to use==
==How to use==

Revision as of 23:17, 17 December 2019

Std PythonHelp

Menu location
Help → Automatic Python modules documentation
Workbenches
All
Default shortcut
None
Introduced in version
-
See also
Help menu, What's This?, Users documentation

Description

Std PythonHelp starts a web server that communicates with your default browser over a local socket. The page that opens displays the available Python modules, classes and functions of FreeCAD; the different pages are generated in the background automatically.

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

How to use

  1. Open the menu Help Automatic Python modules documentation
  2. Click on any of the links to go to the specific class or function documentation.