Std Documentation des modules 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 100% complete.
Other languages:
English • ‎français • ‎italiano • ‎русский
Page suivante : Forum de FreeCAD Std FreeCADForum.svg Arrow-right.svg

Std PythonHelp.svg Std Documentation automatique des modules Python

Emplacement du menu
Aide → Documentation automatique des modules Python
Ateliers
Tous
Raccourci par défaut
Aucun
Introduit dans la version
-
Voir aussi
Std Documentation pour scripter en Python


Description

La commande Std Documentation des modules Python démarre un serveur Web qui communique avec le navigateur Internet par défaut du système via un socket local. Le serveur Web affiche des informations sur les modules, classes et fonctions Python disponibles de FreeCAD. Les pages requises sont générées automatiquement.

Le serveur Web est basé sur le module pydoc de Python et extrait ainsi les docstrings (chaîne de caractères) des fichiers Python (.py) et la documentation textuelle définie dans les wrappers Python (.xml) qui exposent le code C++ sous-jacent.

Utilisation

  1. Sélectionnez l'option Aide → Std PythonHelp.svg Documentation automatique des modules python dans le menu.
  2. Cliquez sur l'un des liens pour accéder à la documentation d'une classe ou d'une fonction spécifique.
Page suivante : Forum de FreeCAD Std FreeCADForum.svg Arrow-right.svg