Std PythonHelp
Jump to navigation
Jump to search
Std Base
User documentation
|
|
| Menu location |
|---|
| Help → Automatic python modules documentation |
| Workbenches |
| All |
| Default shortcut |
| None |
| Introduced in version |
| - |
| See also |
| Std FreeCADPowerUserHub |
Contents |
Description
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 modules, classes and functions of FreeCAD. The required pages are generated automatically.
The web server is based on Python's pydoc module, and thus extracts the docstrings of Python files (.py), and textual documentation defined in the Python wrappers (.xml) which expose the underlying C++ code.
Usage
- Select the Help →
Automatic python modules documentation option from the menu. - Click on any of the links to go to the documentation of a specific class or function.
Std Base
- Standard menu: File, Edit, View, Tools, Macro, Windows, Help
- Structure: Std Part, Std Group, Std LinkMake, Std LinkActions (Std LinkMakeRelative, Std LinkReplace, Std LinkUnlink, Std LinkImport, Std LinkImportAll)
- 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, Placement, Alignment, Toggle Edit mode, Preferences
- View: Create new view, Orthographic view, Perspective view, Fullscreen, Standard views (Fit all, Fit selection, Isometric, Dimetric, Trimetric, Front, Top, Right, Rear, Bottom, Left, Rotate left, Rotate right), Freeze display (Save views, Load views, Freeze view, Clear views), Draw style (As is, Flat lines, Shaded, Wireframe, Points, Hidden line, No shading), Bounding box, Stereo (red/cyan, quad buffer, interleaved rows, interleaved columns, Stereo off, Issue camera position), Zoom (Zoom In, Zoom Out, Box zoom), Document window (Docked, Undocked, Full screen), Toggle axis cross, Clipping plane, Texture mapping, 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), Toggle navigation/edit mode, Appearance, Random color, Workbench, Toolbars (File, Workbench, Macro, View, Structure, Navigation), Panels (Report view, Tree view, Property view, Selection view, Combo view, Python console, DAG view), Tree view actions (Sync view, Sync selection, Sync placement, Pre-selection, Record selection, Single document, Multi document, Collapse/expand, Initiate dragging, Go to selection), Status bar
- Tools: Edit parameters, Save picture, Scene inspector, Dependency graph, Project utility, Measure distance, Text document, View turntable, Units calculator, Customize, Addon manager
- Macro: Macro recording, Stop macro recording, Macros, Execute macro, Debug macro, Stop debugging, Step over, Step into, Toggle breakpoint
- Windows: Next, Previous, Tile, Cascade, Arrange icons, Windows
- Help: Help, FreeCAD Website, Users documentation, Python scripting documentation, Automatic Python modules documentation, FreeCAD forum, FreeCAD FAQ, About FreeCAD, What's This
User documentation
- Getting started
- Installation: Download, Linux, Windows, MacOS, 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, Draft, FEM, Image, Inspection, Mesh, OpenSCAD, Part, PartDesign, Path, Points, Raytracing, Reverse Engineering, Sketcher, Spreadsheet, Start, Surface workbench, TechDraw, Test Framework, Web
- Unmaintained workbenches: Plot, Robot, Ship
- Deprecated workbenches: Complete, Drawing
- Code: Addon Manager, Addons, Macros, External workbenches
- Hubs: User hub, Power users hub, Developer hub
