Std PythonHelp/fr: Difference between revisions

From FreeCAD Documentation
No edit summary
No edit summary
 
(7 intermediate revisions by 2 users not shown)
Line 2: Line 2:


{{Docnav/fr
{{Docnav/fr
|[[Std_FreeCADPowerUserHub/fr|Documentation pour scripter en Python]]
|[[Std_FreeCADPowerUserHub/fr|Documentation pour programmer en Python]]
|[[Std_FreeCADForum/fr|Forum de FreeCAD]]
|[[Std_FreeCADForum/fr|Forum de FreeCAD]]
|[[Std_Help_Menu/fr|Menu Aide]]
|[[Std_Help_Menu/fr|Menu Aide]]
Line 15: Line 15:
|MenuLocation=Aide → Documentation automatique des modules Python
|MenuLocation=Aide → Documentation automatique des modules Python
|Workbenches=Tous
|Workbenches=Tous
|SeeAlso=[[Std_FreeCADPowerUserHub/fr|Std Documentation pour scripter en Python]]
|SeeAlso=[[Std_FreeCADPowerUserHub/fr|Std Documentation pour programmer en Python]]
}}
}}


==Description==
==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/fr|Python]] disponibles de FreeCAD. Les pages requises sont générées automatiquement.
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/fr|Python]] disponibles de FreeCAD. Les pages requises sont générées automatiquement.


Le serveur Web est basé sur le module [https://docs.python.org/3.8/library/pydoc.html#module-pydoc pydoc] de Python et extrait ainsi les docstrings (chaîne de caractères) des fichiers Python ({{incode|.py}}) et la documentation textuelle définie dans les wrappers Python ({{incode|.xml}}) qui exposent le code C++ sous-jacent.
Le serveur Web est basé sur le module [https://docs.python.org/3.8/library/pydoc.html#module-pydoc pydoc] de Python et extrait ainsi les docstrings (chaîne de caractères) des fichiers Python ({{incode|.py}}) et la documentation textuelle définie dans les wrappers Python ({{incode|.xml}}) qui exposent le code C++ sous-jacent.


<span id="Usage"></span>
==Utilisation==
==Utilisation==


Line 30: Line 31:


{{Docnav/fr
{{Docnav/fr
|[[Std_FreeCADPowerUserHub/fr|Documentation pour scripter en Python]]
|[[Std_FreeCADPowerUserHub/fr|Documentation pour programmer en Python]]
|[[Std_FreeCADForum/fr|Forum de FreeCAD]]
|[[Std_FreeCADForum/fr|Forum de FreeCAD]]
|[[Std_Help_Menu|Menu Aide]]
|[[Std_Help_Menu/fr|Menu Aide]]
|IconL=Std_FreeCADPowerUserHub.svg
|IconL=Std_FreeCADPowerUserHub.svg
|IconR=Std_FreeCADForum.svg
|IconR=Std_FreeCADForum.svg

Latest revision as of 14:59, 18 November 2023

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 programmer 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 → 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.