Std PythonHelp/fr: Difference between revisions

From FreeCAD Documentation
(Created page with "==Description==")
 
No edit summary
 
(28 intermediate revisions by 3 users not shown)
Line 1: Line 1:
<languages/>
<languages/>


{{Docnav/fr
{{GuiCommand
|[[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
|Name=Std PythonHelp
|Name=Std PythonHelp
|Name/fr=Std Documentation automatique des modules Python
|MenuLocation=[[Std Help Menu|Help]] → Automatic Python modules documentation
|MenuLocation=Aide → Documentation automatique des modules Python
|Workbenches=All
|Workbenches=Tous
|SeeAlso=[[Std_OnlineHelp|Online help]], [[Std_FreeCADPowerUserHub|Power user hub]], [[Std_Help_Menu|Help menu]]
|SeeAlso=[[Std_FreeCADPowerUserHub/fr|Std Documentation pour programmer en Python]]
}}
}}


==Description==
==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/fr|Python]] disponibles de FreeCAD. Les pages requises sont générées automatiquement.
[[Std_PythonHelp|Std PythonHelp]] starts a web server that communicates with your default browser over a local socket. The page that opens displays the available [[Python|Python]] modules, classes and functions of FreeCAD; the different pages are generated in the background automatically.


This web server is based on Python's [https://docs.python.org/3.8/library/pydoc.html#module-pydoc pydoc] module, and thus it extracts the docstrings of Python files ({{incode|.py}}), and textual documentation defined in the Python wrappers ({{incode|.xml}}) which expose the underlying C++ code.
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>
==How to use==
==Utilisation==


# Open the menu {{MenuCommand|[[Std_Help_Menu|Help]] → [[File:Std_PythonHelp.svg|16px]] [[Std_PythonHelp|Automatic Python modules documentation]]}}
# Sélectionnez l'option {{MenuCommand|Aide → [[Image:Std_PythonHelp.svg|16px]] Documentation automatique des modules python}} dans le menu.
# Cliquez sur l'un des liens pour accéder à la documentation d'une classe ou d'une fonction spécifique.
# Click on any of the links to go to the specific class or function documentation.

{{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
}}


{{Std Base navi{{#translation:}}}}
{{Std_Base}}
{{Userdocnavi}}
{{Userdocnavi{{#translation:}}}}
{{clear}}
{{clear}}

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.