Команда "Автоматический сгенерированная документация Python"

From FreeCAD Documentation
Jump to navigation Jump to search
This page is a translated version of the page Std PythonHelp and the translation is 67% complete.
Other languages:
Deutsch • ‎English • ‎français • ‎italiano • ‎polski • ‎português do Brasil • ‎русский

Std PythonHelp.svg Std PythonHelp

Системное название
Std PythonHelp
Расположение в меню
Help → Automatic python modules documentation
Верстаки
All
Быстрые клавиши
Нет
Представлено в версии
-
См. также
Std FreeCADPowerUserHub

Описание

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.

Применение

  1. Select the Help → Std PythonHelp.svg 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.