Std PythonHelp/fr: Difference between revisions

From FreeCAD Documentation
No edit summary
No edit summary
 
(17 intermediate revisions by 2 users not shown)
Line 1: Line 1:
<languages/>
<languages/>

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


{{GuiCommand/fr
{{GuiCommand/fr
|Name=Std PythonHelp
|Name=Std PythonHelp
|Name/fr=Std Documentation modules Python
|Name/fr=Std Documentation automatique des modules Python
|MenuLocation={{StdMenu|[[Std Help Menu/fr|Aide]]}} → Documentation automatique des modules Python
|MenuLocation=Aide → Documentation automatique des modules Python
|Workbenches=Tous
|Workbenches=Tous
|SeeAlso=[[Std_OnlineHelp/fr|Std Aide]], [[Std_FreeCADPowerUserHub/fr|Std Power user hub]], [[Std_Help_Menu/fr |Std Menu Aide]]
|SeeAlso=[[Std_FreeCADPowerUserHub/fr|Std Documentation pour programmer en Python]]
}}
}}


==Description==
==Description==


[[Std_PythonHelp/fr|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/fr|Python]] disponibles de FreeCAD. Les différentes pages sont générées en arrière-plan 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.


Ce 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==


# Sélectionnez l'option {{MenuCommand|Aide → [[Image:Std_PythonHelp.svg|16px]] Documentation automatique des modules python}} dans le menu.
<div class="mw-translate-fuzzy">
# Cliquez sur l'un des liens pour accéder à la documentation d'une classe ou d'une fonction spécifique.
# Ouvrez le menu {{MenuCommand|[[Std_Help_Menu/fr|Aide]] → [[File:Std_PythonHelp.svg|16px]] [[Std_PythonHelp/fr|Documentation automatique des modules Python]]}}

# Cliquez sur l'un des liens pour accéder à la documentation de classe ou de fonction spécifique.
{{Docnav/fr
</div>
|[[Std_FreeCADPowerUserHub/fr|Documentation pour programmer en Python]]
|[[Std_FreeCADForum/fr|Forum de FreeCAD]]
|[[Std_Help_Menu/fr|Menu Aide]]
|IconL=Std_FreeCADPowerUserHub.svg
|IconR=Std_FreeCADForum.svg
|IconC=Freecad.svg
}}


{{Std Base navi{{#translation:}}}}
{{Std Base navi{{#translation:}}}}

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.