Std Documentation des modules Python

From FreeCAD Documentation
Revision as of 13:30, 27 June 2020 by David69 (talk | contribs)

Std Documentation automatique 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 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.

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