diff --git a/src/Doc/sphinx/Arch.rst b/src/Doc/sphinx/Arch.rst index c126eb327..e89fca847 100644 --- a/src/Doc/sphinx/Arch.rst +++ b/src/Doc/sphinx/Arch.rst @@ -1,7 +1,7 @@ The Arch module =============== -The Arch module is a metamodule that imports useful methods from several of the Arch submodules. +The Arch module is a metamodule that imports useful methods from several of the Arch submodules. You can invoke the following methods either from their specific submodule (ArchWall.areSameWallTypes()) or from the Arch module itself (Arch.areSameWallTypes()). .. toctree:: :maxdepth: 4 @@ -9,29 +9,32 @@ The Arch module is a metamodule that imports useful methods from several of the .. automodule:: Arch :members: -.. automodule:: Wall +.. automodule:: ArchWall :members: -.. automodule:: Cell +.. automodule:: ArchCell :members: -.. automodule:: Floor +.. automodule:: ArchFloor :members: -.. automodule:: Site +.. automodule:: ArchSite :members: -.. automodule:: Structure +.. automodule:: ArchStructure :members: -.. automodule:: Window +.. automodule:: ArchWindow :members: -.. automodule:: SectionPlane +.. automodule:: ArchSectionPlane :members: -.. automodule:: Building +.. automodule:: ArchBuilding :members: -.. automodule:: Commands +.. automodule:: ArchCommands + :members: + +.. automodule:: ArchAxis :members: diff --git a/src/Doc/sphinx/Draft.rst b/src/Doc/sphinx/Draft.rst index 542acff0b..2b4101780 100644 --- a/src/Doc/sphinx/Draft.rst +++ b/src/Doc/sphinx/Draft.rst @@ -1,19 +1,21 @@ The Draft module ================ -The Draft module offer several convenient functions to work with simple 2D and 3D objects. -These functions can be used in scripts and macros or from the python interpreter, once the Draft module has been imported. - -Example:: - - import FreeCAD - from Draft import * - myrect = makeRectangle(4,3) - mydistance = FreeCAD.Vector(2,2,0) - move(myrect,mydistance) +The Draft module offer several convenient functions to work with simple objects. .. toctree:: :maxdepth: 4 .. automodule:: Draft :members: + +.. automodule:: DraftSnap + :members: + +The draftlibs contain two submodules, widely used throughout the Draft module: fcvec, which contains useful methods for dealing with vectors, and fcgeo, which offers many tools for working with Part shape objects. + +.. automodule:: draftlibs.fcvec + :members: + +.. automodule:: draftlibs.fcgeo + :members: \ No newline at end of file diff --git a/src/Doc/sphinx/FreeCAD.rst b/src/Doc/sphinx/FreeCAD.rst index cb37b3c4d..eff8e09cf 100644 --- a/src/Doc/sphinx/FreeCAD.rst +++ b/src/Doc/sphinx/FreeCAD.rst @@ -6,7 +6,6 @@ The FreeCAD module .. automodule:: FreeCAD :members: - :show-inheritance: .. autoclass:: Vector :members: @@ -16,3 +15,6 @@ The FreeCAD module .. autoclass:: Placement :members: + + .. autoclass:: Console + :members: diff --git a/src/Mod/Draft/DraftSnap.py b/src/Mod/Draft/DraftSnap.py index c14841f91..d3e8488f4 100644 --- a/src/Mod/Draft/DraftSnap.py +++ b/src/Mod/Draft/DraftSnap.py @@ -47,6 +47,9 @@ class Snapper: the form [real_point,marker_type,visual_point], and are not meant to be used directly, they are all called when necessary by the general snap() function. + + The Snapper lives inside FreeCADGui once the Draft module has been + loaded. """ @@ -661,7 +664,8 @@ class Snapper: def getPoint(self,last=None,callback=None,movecallback=None,extradlg=None): - """getPoint([last],[callback],[movecallback],[extradlg]) : gets a 3D point + """ + getPoint([last],[callback],[movecallback],[extradlg]) : gets a 3D point from the screen. You can provide an existing point, in that case additional snap options and a tracker are available. You can also pass a function as callback, which will get called @@ -675,10 +679,13 @@ class Snapper: def cb(point): if point: print "got a 3D point: ",point + FreeCADGui.Snapper.getPoint(callback=cb) If the callback function accepts more than one argument, it will also receive - the last snapped object. Finally, a pyqt dialog can be passed as extra taskbox.""" + the last snapped object. Finally, a pyqt dialog can be passed as extra taskbox. + + """ import inspect