Std PythonHelp/pt-br: Difference between revisions

From FreeCAD Documentation
(Created page with "==Utilização==")
(Created page with "{{Docnav |FreeCADPowerUserHub |FreeCADForum |Menu de Ajuda Padrão |IconL=Std_FreeCADPower...")
 
(9 intermediate revisions by the same user not shown)
Line 2: Line 2:


{{Docnav
{{Docnav
|[[Std_FreeCADPowerUserHub|FreeCADPowerUserHub]]
|[[Std_FreeCADPowerUserHub/pt-br|FreeCADPowerUserHub]]
|[[Std_FreeCADForum|FreeCADForum]]
|[[Std_FreeCADForum/pt-br|FreeCADForum]]
|[[Std_Help_Menu|Std Help Menu]]
|[[Std_Help_Menu/pt-br|Menu de Ajuda Padrão]]
|IconL=Std_FreeCADPowerUserHub.svg
|IconL=Std_FreeCADPowerUserHub.svg
|IconR=Std_FreeCADForum.svg
|IconR=Std_FreeCADForum.svg
Line 12: Line 12:
{{GuiCommand
{{GuiCommand
|Name=Std PythonHelp
|Name=Std PythonHelp
|MenuLocation=HelpAutomatic python modules documentation
|MenuLocation=AjudaDocumentação automática dos módulos python
|Workbenches=All
|Workbenches=Todas
|SeeAlso=[[Std_FreeCADPowerUserHub|Std FreeCADPowerUserHub]]
|Veja também =[[Std_FreeCADPowerUserHub/pt-br|Std FreeCADPowerUserHub]]
}}
}}


==Descrição==
==Descrição==


The '''Std PythonHelp''' command starts a web server that communicates with the system's default Internet browser over a local socket. The web server displays information about the available [[Python|Python]] modules, classes and functions of FreeCAD. The required pages are generated automatically.
O comando '''Std PythonHelp'' inicia um servidor web que se comunica com o navegador de Internet padrão do sistema através de uma conexão local. O servidor web exibe informações sobre os módulos [[Python/pt-br|Python]] disponíveis, classes e funções do FreeCAD. As páginas necessárias são geradas automaticamente.


The web server is based on Python's [https://docs.python.org/3.8/library/pydoc.html#module-pydoc pydoc] module, and thus extracts the docstrings of Python files ({{incode|.py}}), and textual documentation defined in the Python wrappers ({{incode|.xml}}) which expose the underlying C++ code.
O servidor web é baseado no módulo Python [https://docs.python.org/3.8/library/pydoc.html#module-pydoc pydoc], e assim extrai os documentos dos arquivos Python ({{incode|.py}}), e a documentação textual definida nos invólucros Python ({{incode|.xml}}), que expõem o código C++ subjacente.


==Utilização==
==Utilização==


# Select the {{MenuCommand|Help → [[Image:Std_PythonHelp.svg|16px]] Automatic python modules documentation}} option from the menu.
#Selecione o {{{MenuCommand|Ajuda → [[Image:Std_PythonHelp.svg|16px]] Documentação automática dos módulos python}}} no menu.
# Click on any of the links to go to the documentation of a specific class or function.
# Clique em qualquer um dos links para ir para a documentação de uma classe ou função específica.


{{Docnav
{{Docnav
|[[Std_FreeCADPowerUserHub|FreeCADPowerUserHub]]
|[[Std_FreeCADPowerUserHub/pt-br|FreeCADPowerUserHub]]
|[[Std_FreeCADForum|FreeCADForum]]
|[[Std_FreeCADForum/pt-br|FreeCADForum]]
|[[Std_Help_Menu|Std Help Menu]]
|[[Std_Help_Menu/pt-br|Menu de Ajuda Padrão]]
|IconL=Std_FreeCADPowerUserHub.svg
|IconL=Std_FreeCADPowerUserHub.svg
|IconR=Std_FreeCADForum.svg
|IconR=Std_FreeCADForum.svg

Latest revision as of 17:35, 22 July 2021

Other languages:

Std PythonHelp

Menu location
Ajuda → Documentação automática dos módulos python
Workbenches
Todas
Default shortcut
None
Introduced in version
-
See also
None

Descrição

O comando 'Std PythonHelp inicia um servidor web que se comunica com o navegador de Internet padrão do sistema através de uma conexão local. O servidor web exibe informações sobre os módulos Python disponíveis, classes e funções do FreeCAD. As páginas necessárias são geradas automaticamente.

O servidor web é baseado no módulo Python pydoc, e assim extrai os documentos dos arquivos Python (.py), e a documentação textual definida nos invólucros Python (.xml), que expõem o código C++ subjacente.

Utilização

  1. Selecione o Ajuda → Documentação automática dos módulos python no menu.
  2. Clique em qualquer um dos links para ir para a documentação de uma classe ou função específica.