Std PythonHelp: Difference between revisions

Revision as of 04:09, 19 February 2020

Other languages:

Menu location
Std PythonHelp
Help → Automatic Python modules documentation
Workbenches
All
Default shortcut
None
Introduced in version
-
See also
Online help, Power user hub, Help menu

Description

Std PythonHelp starts a web server that communicates with your default browser over a local socket. The page that opens displays the available Python modules, classes and functions of FreeCAD; the different pages are generated in the background automatically.

This web server is based on Python's pydoc module, and thus it extracts the docstrings of Python files (.py), and textual documentation defined in the Python wrappers (.xml) which expose the underlying C++ code.

Usage

Open the menu Help → Automatic Python modules documentation
Click on any of the links to go to the specific class or function documentation.

Std Base

File: New, Open, Close, Close All, Save, Save As, Save a Copy, Save All, Revert, Import, Export,Merge project, Project information, Print, Print preview, Export PDF, Recent files, Exit

Edit: Undo, Redo, Cut, Copy, Paste, Duplicate selection, Refresh, Box selection, Box element selection, Select All, Delete, Send to Python Console, Placement, Transform, Alignment, Toggle Edit mode, Edit mode, Preferences

View:
- Miscellaneous: Create new view, Orthographic view, Perspective view, Fullscreen, Bounding box, Toggle axis cross, Clipping plane, Texture mapping, Toggle navigation/Edit mode, Appearance, Random color, Workbench, Status bar
- Standard views: Fit all, Fit selection, Isometric, Dimetric, Trimetric, Home, Front, Top, Right, Rear, Bottom, Left, Rotate Left, Rotate Right
- Freeze display: Save views, Load views, Freeze view, Clear views
- Draw style: As is, Points, Wireframe, Hidden line, No shading, Shaded, Flat lines
- Stereo: Stereo red/cyan, Stereo quad buffer, Stereo Interleaved Rows, Stereo Interleaved Columns, Stereo Off, Issue camera position
- Zoom: Zoom In, Zoom Out, Box zoom
- Document window: Docked, Undocked, Fullscreen
- Visibility: Toggle visibility, Show selection, Hide selection, Select visible objects, Toggle all objects, Show all objects, Hide all objects, Toggle selectability, Toggle measurement, Clear measurement
- Toolbars: File, Edit, Clipboard, Workbench, Macro, View, Structure, Help
- Panels: Tree view, Property view, Selection view, Tasks, Python console, DAG view, Model, Report view
- Link navigation: Go to linked object, Go to the deepest linked object, Select all links
- Tree view actions: Sync view, Sync selection, Sync placement, Pre-selection, Record selection, Single document, Multi document, Collapse/Expand, Initiate dragging, Go to selection, Selection Back, Selection Forward

Tools: Edit parameters, Save image, Load image, Scene inspector, Dependency graph, Project utility, Measure distance, Add text document, View turntable, Units calculator, Customize, Addon manager

Macro: Macro recording, Macros, Recent macros, Execute macro, Attach to remote debugger, Debug macro, Stop debugging, Step over, Step into, Toggle breakpoint

Windows: Next, Previous, Tile, Cascade, Windows

Help: Help, FreeCAD Website, Donate, Users documentation, Python scripting documentation, Automatic Python modules documentation, FreeCAD Forum, FreeCAD FAQ, Report a bug, About FreeCAD, What's This

Structure and Link: Std Part, Std Group, Make link, Make sub-link, Replace with link, Unlink, Import links, Import all links

User documentation

Getting started
Installation: Download, Windows, Linux, Mac, Additional components, Docker, AppImage, Ubuntu Snap
Basics: About FreeCAD, Interface, Mouse navigation, Selection methods, Object name, Preferences, Workbenches, Document structure, Properties, Help FreeCAD, Donate

Help: Tutorials, Video tutorials
Workbenches: Std Base, Arch, Assembly, CAM, Draft, FEM, Inspection, Mesh, OpenSCAD, Part, PartDesign, Points, Reverse Engineering, Robot, Sketcher, Spreadsheet, Start, Surface, TechDraw, Test Framework, Web

Addons: Addon Manager, External workbenches, Scripting and macros

Hubs: User hub, Power users hub, Developer hub

@@ Line 5: / Line 5: @@
 {{GuiCommand
 |Name=Std PythonHelp
-|MenuLocation=[[Std Help Menu|Help]] → Automatic Python modules documentation
+|MenuLocation={{StdMenu|[[Std Help Menu|Help]]}} → Automatic Python modules documentation
 |Workbenches=All
 |SeeAlso=[[Std_OnlineHelp|Online help]], [[Std_FreeCADPowerUserHub|Power user hub]], [[Std_Help_Menu|Help menu]]
@@ Line 18: / Line 18: @@
 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.
-==How to use== <!--T:5-->
+==Usage== <!--T:5-->
 <!--T:6-->
-# Open the menu {{MenuCommand|[[Std_Help_Menu|Help]] → [[File:Std_PythonHelp.svg|16px]] [[Std_PythonHelp|Automatic Python modules documentation]]}}
+# Open the menu {{MenuCommand|{{StdMenu|[[Std_Help_Menu|Help]]}} → [[File:Std_PythonHelp.svg|16px]] [[Std_PythonHelp|Automatic Python modules documentation]]}}
 # Click on any of the links to go to the specific class or function documentation.