Docs: update for 2.3.0

mgear-dev · Dec 6, 2017 · 34b026f · 34b026f
1 parent 52c7849
commit 34b026f
Show file tree

Hide file tree

Showing 33 changed files with 226 additions and 86 deletions.
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -19,8 +19,8 @@
 # add these directories to sys.path here. If the directory is relative to the
 # documentation root, use os.path.abspath to make it absolute, like shown here.
 # sys.path.insert(0, os.path.abspath('.'))
-sys.path.insert(0, os.path.abspath('C:\\datawork\\repo\\mgear\\scripts'))
-
+# sys.path.insert(0, os.path.abspath('C:\\datawork\\repo\\mgear\\scripts'))
+sys.path.insert(0, os.path.abspath('../'))
 # -- General configuration ------------------------------------------------
 
 # If your documentation needs a minimal Sphinx version, state it here.
@@ -29,7 +29,7 @@
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
-extensions = ['sphinx.ext.autodoc', 'sphinxcontrib.napoleon', 'sphinx.ext.autosummary']
+extensions = ['sphinx.ext.autodoc', 'sphinxcontrib.napoleon', 'sphinx.ext.autosummary', 'sphinx.ext.changelog_links']
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']
@@ -55,9 +55,9 @@
 # built documents.
 #
 # The short X.Y version.
-version = u'2.2'
+version = u'2.3'
 # The full version, including alpha/beta/rc tags.
-release = u'2.2.0'
+release = u'2.3.0'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
@@ -289,5 +289,6 @@
 autosummary_generate = True
 # autodoc_default_flags = ['special-members']
 autoclass_content = "both"
+github_issues_url = 'https://github.com/miquelcampos/mgear/issues/'
 
 # exclude_patterns = ['mgear/maya/*']
diff --git a/docs/source/generated/mgear.maya.applyop.rst b/docs/source/generated/mgear.maya.applyop.rst
@@ -1,5 +1,5 @@
-mgear.maya.applyop
-==================
+mgear\.maya\.applyop
+====================
 
 .. automodule:: mgear.maya.applyop
 
@@ -10,6 +10,7 @@ mgear.maya.applyop
    .. autosummary::
 
       aimCns
+      curvecns_op
       gear_curvecns_op
       gear_curveslide2_op
       gear_ikfk2bone_op

diff --git a/docs/source/generated/mgear.maya.attribute.rst b/docs/source/generated/mgear.maya.attribute.rst
@@ -1,5 +1,5 @@
-mgear.maya.attribute
-====================
+mgear\.maya\.attribute
+======================
 
 .. automodule:: mgear.maya.attribute
 
@@ -13,10 +13,22 @@ mgear.maya.attribute
       addColorAttribute
       addEnumAttribute
       addFCurve
+      addProxyAttribute
+      connectSet
+      getSelectedChannels
+      getSelectedObjectChannels
+      get_default_value
       lockAttribute
+      moveChannel
+      reset_SRT
+      reset_selected_channels_value
       setInvertMirror
       setKeyableAttributes
+      setNotKeyableAttributes
       setRotOrder
+      set_default_value
+      smart_reset
+      unlockAttribute
 
 
 

diff --git a/docs/source/generated/mgear.maya.curve.rst b/docs/source/generated/mgear.maya.curve.rst
@@ -1,5 +1,5 @@
-mgear.maya.curve
-================
+mgear\.maya\.curve
+==================
 
 .. automodule:: mgear.maya.curve
 
@@ -12,6 +12,7 @@ mgear.maya.curve
       addCnsCurve
       addCurve
       createCurveFromCurve
+      createCurveFromOrderedEdges
       createCuveFromEdges
       findLenghtFromParam
       getCurveParamAtPosition

diff --git a/docs/source/generated/mgear.maya.dag.rst b/docs/source/generated/mgear.maya.dag.rst
@@ -1,5 +1,5 @@
-mgear.maya.dag
-==============
+mgear\.maya\.dag
+================
 
 .. automodule:: mgear.maya.dag
 
@@ -13,6 +13,7 @@ mgear.maya.dag
       findChildren
       findChildrenPartial
       findComponentChildren
+      findComponentChildren2
       getShapes
       getTopParent
 

diff --git a/docs/source/generated/mgear.maya.fcurve.rst b/docs/source/generated/mgear.maya.fcurve.rst
@@ -1,5 +1,5 @@
-mgear.maya.fcurve
-=================
+mgear\.maya\.fcurve
+===================
 
 .. automodule:: mgear.maya.fcurve
 

diff --git a/docs/source/generated/mgear.maya.icon.rst b/docs/source/generated/mgear.maya.icon.rst
@@ -1,5 +1,5 @@
-mgear.maya.icon
-===============
+mgear\.maya\.icon
+=================
 
 .. automodule:: mgear.maya.icon
 

diff --git a/docs/source/generated/mgear.maya.log.rst b/docs/source/generated/mgear.maya.log.rst
@@ -1,5 +1,5 @@
-mgear.maya.log
-==============
+mgear\.maya\.log
+================
 
 .. automodule:: mgear.maya.log
 

diff --git a/docs/source/generated/mgear.maya.meshNavigation.rst b/docs/source/generated/mgear.maya.meshNavigation.rst
@@ -1,5 +1,5 @@
-mgear.maya.meshNavigation
-=========================
+mgear\.maya\.meshNavigation
+===========================
 
 .. automodule:: mgear.maya.meshNavigation
 

diff --git a/docs/source/generated/mgear.maya.node.rst b/docs/source/generated/mgear.maya.node.rst
@@ -1,5 +1,5 @@
-mgear.maya.node
-===============
+mgear\.maya\.node
+=================
 
 .. automodule:: mgear.maya.node
 
@@ -23,10 +23,15 @@ mgear.maya.node
       createMulDivNode
       createMulNode
       createMulNodeMulti
+      createMultMatrixNode
       createNegateNodeMulti
       createPairBlend
+      createPlusMinusAverage1D
+      createPowNode
       createReverseNode
+      createSetRangeNode
       createSubNode
+      createVertexPositionNode
 
 
 

diff --git a/docs/source/generated/mgear.maya.primitive.rst b/docs/source/generated/mgear.maya.primitive.rst
@@ -1,5 +1,5 @@
-mgear.maya.primitive
-====================
+mgear\.maya\.primitive
+======================
 
 .. automodule:: mgear.maya.primitive
 

diff --git a/docs/source/generated/mgear.maya.rst b/docs/source/generated/mgear.maya.rst
@@ -1,5 +1,5 @@
-mgear.maya
-==========
+mgear\.maya
+===========
 
 .. automodule:: mgear.maya
 
@@ -9,6 +9,7 @@ mgear.maya
 
    .. autosummary::
 
+      aboutMgear
       getMayaVer
 
 

diff --git a/docs/source/generated/mgear.maya.shifter.component.guide.rst b/docs/source/generated/mgear.maya.shifter.component.guide.rst
@@ -1,5 +1,5 @@
-mgear.maya.shifter.component.guide
-==================================
+mgear\.maya\.shifter\.component\.guide
+======================================
 
 .. automodule:: mgear.maya.shifter.component.guide
 
@@ -14,9 +14,9 @@ mgear.maya.shifter.component.guide
    .. autosummary::
 
       ComponentGuide
-      MainGuide
       MinMax
-      partial
+      componentMainSettings
+      mainSettingsTab
 
 
 

diff --git a/docs/source/generated/mgear.maya.shifter.component.rst b/docs/source/generated/mgear.maya.shifter.component.rst
@@ -1,5 +1,5 @@
-mgear.maya.shifter.component
-============================
+mgear\.maya\.shifter\.component
+===============================
 
 .. automodule:: mgear.maya.shifter.component
 
@@ -13,6 +13,7 @@ mgear.maya.shifter.component
 
    .. autosummary::
 
+      Main
       MainComponent
 
 

diff --git a/docs/source/generated/mgear.maya.shifter.gui.rst b/docs/source/generated/mgear.maya.shifter.gui.rst
@@ -1,5 +1,5 @@
-mgear.maya.shifter.gui
-======================
+mgear\.maya\.shifter\.gui
+=========================
 
 .. automodule:: mgear.maya.shifter.gui
 
@@ -14,7 +14,6 @@ mgear.maya.shifter.gui
    .. autosummary::
 
       Guide_UI
-      partial
 
 
 

diff --git a/docs/source/generated/mgear.maya.shifter.guide.rst b/docs/source/generated/mgear.maya.shifter.guide.rst
@@ -1,5 +1,5 @@
-mgear.maya.shifter.guide
-========================
+mgear\.maya\.shifter\.guide
+===========================
 
 .. automodule:: mgear.maya.shifter.guide
 
@@ -13,8 +13,18 @@ mgear.maya.shifter.guide
 
    .. autosummary::
 
+      CustomStepTab
+      GuideSettings
+      GuideSettingsTab
+      HelperSlots
+      Main
       MainGuide
+      Rig
       RigGuide
+      customStepTab
+      guideSettings
+      guideSettingsTab
+      helperSlots
 
 
 

diff --git a/docs/source/generated/mgear.maya.shifter.rst b/docs/source/generated/mgear.maya.shifter.rst
@@ -1,10 +1,18 @@
-mgear.maya.shifter
-==================
+mgear\.maya\.shifter
+====================
 
 .. automodule:: mgear.maya.shifter
 
 
 
+   .. rubric:: Functions
+
+   .. autosummary::
+
+      getComponentDirectories
+      importComponent
+      importComponentGuide
+
 
 
 
@@ -13,9 +21,7 @@ mgear.maya.shifter
 
    .. autosummary::
 
-      MainComponent
       Rig
-      RigGuide
 
 
 

diff --git a/docs/source/generated/mgear.maya.skin.rst b/docs/source/generated/mgear.maya.skin.rst
@@ -1,5 +1,5 @@
-mgear.maya.skin
-===============
+mgear\.maya\.skin
+=================
 
 .. automodule:: mgear.maya.skin
 
@@ -13,11 +13,13 @@ mgear.maya.skin
       collectData
       collectInfluenceWeights
       exportSkin
+      exportSkinPack
       getCurrentWeights
       getGeometryComponents
       getObjsFromSkinFile
       getSkinCluster
       importSkin
+      importSkinPack
       selectDeformers
       setBlendWeights
       setData

diff --git a/docs/source/generated/mgear.maya.synoptic.rst b/docs/source/generated/mgear.maya.synoptic.rst
@@ -1,5 +1,5 @@
-mgear.maya.synoptic
-===================
+mgear\.maya\.synoptic
+=====================
 
 .. automodule:: mgear.maya.synoptic
 
@@ -9,10 +9,8 @@ mgear.maya.synoptic
 
    .. autosummary::
 
-      getMayaWindow
+      importTab
       open
-      wrapInstance
-      wrapinstance2
 
 
 
@@ -23,6 +21,7 @@ mgear.maya.synoptic
    .. autosummary::
 
       Synoptic
+      SynopticTabWrapper