Std PythonHelp/pl: Difference between revisions

From FreeCAD Documentation
(Created page with "==Opis==")
(Created page with "==Użycie==")
Line 24: Line 24:
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.
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==
<span id="Usage"></span>
==Użycie==


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

Revision as of 20:48, 16 January 2023

Std PythonHelp

Menu location
Help → Automatic python modules documentation
Workbenches
All
Default shortcut
None
Introduced in version
-
See also
Std FreeCADPowerUserHub

Opis

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.

Użycie

  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.