suzanne.soy/FreeCAD
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Small improvements to sphinx API docs generator

Browse Source
This commit is contained in:
Yorik van Havre 2012-03-14 13:27:07 -03:00
parent 1f690c0c81
commit 13e5e28625
4 changed files with 37 additions and 23 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
src/Doc/sphinx/Arch.rst
View File

@ -1,7 +1,7 @@
The Arch module 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:: .. toctree::
:maxdepth: 4 :maxdepth: 4
@ -9,29 +9,32 @@ The Arch module is a metamodule that imports useful methods from several of the
.. automodule:: Arch .. automodule:: Arch
:members: :members:
.. automodule:: Wall .. automodule:: ArchWall
:members: :members:
.. automodule:: Cell .. automodule:: ArchCell
:members: :members:
.. automodule:: Floor .. automodule:: ArchFloor
:members: :members:
.. automodule:: Site .. automodule:: ArchSite
:members: :members:
.. automodule:: Structure .. automodule:: ArchStructure
:members: :members:
.. automodule:: Window .. automodule:: ArchWindow
:members: :members:
.. automodule:: SectionPlane .. automodule:: ArchSectionPlane
:members: :members:
.. automodule:: Building .. automodule:: ArchBuilding
:members: :members:
.. automodule:: Commands .. automodule:: ArchCommands
:members:
.. automodule:: ArchAxis
:members: :members:

22
src/Doc/sphinx/Draft.rst
View File

@ -1,19 +1,21 @@
The Draft module The Draft module
================ ================
The Draft module offer several convenient functions to work with simple 2D and 3D objects. The Draft module offer several convenient functions to work with simple 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)
.. toctree:: .. toctree::
:maxdepth: 4 :maxdepth: 4
.. automodule:: Draft .. automodule:: Draft
:members: :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:

4
src/Doc/sphinx/FreeCAD.rst
View File

@ -6,7 +6,6 @@ The FreeCAD module
.. automodule:: FreeCAD .. automodule:: FreeCAD
:members: :members:
:show-inheritance:
.. autoclass:: Vector .. autoclass:: Vector
:members: :members:
@ -16,3 +15,6 @@ The FreeCAD module
.. autoclass:: Placement .. autoclass:: Placement
:members: :members:
.. autoclass:: Console
:members:

11
src/Mod/Draft/DraftSnap.py
View File

@ -48,6 +48,9 @@ class Snapper:
meant to be used directly, they are all called when necessary by meant to be used directly, they are all called when necessary by
the general snap() function. the general snap() function.
The Snapper lives inside FreeCADGui once the Draft module has been
loaded.
""" """
def __init__(self): def __init__(self):
@ -661,7 +664,8 @@ class Snapper:
def getPoint(self,last=None,callback=None,movecallback=None,extradlg=None): 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 from the screen. You can provide an existing point, in that case additional
snap options and a tracker are available. snap options and a tracker are available.
You can also pass a function as callback, which will get called You can also pass a function as callback, which will get called
@ -675,10 +679,13 @@ class Snapper:
def cb(point): def cb(point):
if point: if point:
print "got a 3D point: ",point print "got a 3D point: ",point
FreeCADGui.Snapper.getPoint(callback=cb) FreeCADGui.Snapper.getPoint(callback=cb)
If the callback function accepts more than one argument, it will also receive 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 import inspect