Std Documentation 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 • ‎русский

Std PythonHelp.svg Std Documentation 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 Aide, Std Power user hub, Std Menu Aide


Description

Std Documentation modules Python démarre un serveur Web qui communique avec votre navigateur par défaut via une socket locale. La page qui s'ouvre affiche les modules, classes et fonctions Python disponibles de FreeCAD. Les différentes pages sont générées en arrière-plan automatiquement.

Ce 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. Ouvrez le menu AideStd PythonHelp.svg Documentation automatique des modules Python
  2. Cliquez sur l'un des liens pour accéder à la documentation de classe ou de fonction spécifique.