Refactored the docstrings with correct author name

Bug fix that was making the sphinx-build very slow

Refactored the docstrings with correct author name
Bug fix that was making the sphinx-build very slow
9f2e95dd · eric pellegrini · 34e84eaa · 9f2e95dd · 9f2e95dd · 9f2e95dd
Commit 9f2e95dd authored Jun 16, 2015 by eric pellegrini
248 changed files
--- a/Doc/conf.py
+++ b/Doc/conf.py
@@ -27,7 +27,7 @@
 ''' 
 Created on Mar 30, 2015

-@author: goret
+@author: Gael Goret and Eric C. Pellegrini
 '''


@@ -130,24 +130,28 @@ man_pages = [('index', 'MDANSE', u'MDANSE Documentation', u'Gael Goret & Eric C.
 #  dir menu entry, description, category)
 texinfo_documents = [('index', 'MDANSE', u'MDANSE Documentation',u'Gael Goret & Eric C. Pellegrini','MDANSE', 'One line description of project.','Miscellaneous'),]

-# List of directories, relative to source directory, that shouldn't be searched
-# for source files.
+# List of directories, relative to source directory, that shouldn't be searched for source files.
 exclude_patterns = ['Externals']

 members_to_watch = ['class']

+from MDANSE import REGISTRY
+
+klsNames = [kls.__name__ for kls in REGISTRY["job"].values()]
+
 def flag_onthefly(app, what, name, obj, options, lines):
-	from MDANSE import REGISTRY
-	for kls in REGISTRY["job"].values():
-		kls.__doc__ += kls.build_doc()
-	if(what in members_to_watch):
-		# and modify the docstring so the rendered output is highlights the omission
-		if lines:
-			lines.insert(0,'**Description:**\n\n')
-			lines.insert(0,'    .. inheritance-diagram:: %s\n'%name.split('.')[-1])
-			lines.insert(0,'**inheritance-diagram:**\n\n')
-
-# def setup(app):
-# 
-# 	app.connect('autodoc-process-docstring', flag_onthefly)
-	
+        
+    if getattr(obj,'__name__',None) in klsNames:
+        lines.extend(obj.build_doc().splitlines())
+        
+    if what in members_to_watch:
+        # modify the docstring so the rendered output is highlights the omission
+        if lines:
+            lines.insert(0,'\n:Description:\n\n')
+#             lines.insert(0,'    .. inheritance-diagram:: %s' % name.split('.')[-1])
+#             lines.insert(0,'**inheritance-diagram:**')
+            
+def setup(app):
+  
+    app.connect('autodoc-process-docstring', flag_onthefly)
+
--- a/MDANSE/App/GUI/ComboWidgets/UserDefinitionsPanel.py
+++ b/MDANSE/App/GUI/ComboWidgets/UserDefinitionsPanel.py
@@ -27,7 +27,7 @@
 ''' 
 Created on Apr 14, 2015

-@author: pellegrini
+:author: Eric C. Pellegrini
 '''

 import wx

--- a/MDANSE/App/GUI/ConfigurationPanel.py
+++ b/MDANSE/App/GUI/ConfigurationPanel.py
@@ -27,7 +27,7 @@
 ''' 
 Created on Apr 10, 2015

-@author: pellegrini
+:author: Eric C. Pellegrini
 '''

 import wx

--- a/MDANSE/App/GUI/DataController.py
+++ b/MDANSE/App/GUI/DataController.py
@@ -27,7 +27,7 @@
 ''' 
 Created on Apr 10, 2015

-@author: pellegrini
+:author: Eric C. Pellegrini
 '''

 import collections

--- a/MDANSE/App/GUI/DataTreePanel.py
+++ b/MDANSE/App/GUI/DataTreePanel.py
@@ -27,7 +27,7 @@
 ''' 
 Created on Apr 10, 2015

-@author: pellegrini
+:author: Eric C. Pellegrini
 '''

 import wx

--- a/MDANSE/App/GUI/Framework/Handlers/ConsoleHandler.py
+++ b/MDANSE/App/GUI/Framework/Handlers/ConsoleHandler.py
@@ -27,7 +27,7 @@
 ''' 
 Created on Apr 14, 2015

-@author: pellegrini
+:author: Eric C. Pellegrini
 '''

 import logging

--- a/MDANSE/App/GUI/Framework/Handlers/DialogHandler.py
+++ b/MDANSE/App/GUI/Framework/Handlers/DialogHandler.py
@@ -27,7 +27,7 @@
 ''' 
 Created on Apr 14, 2015

-@author: pellegrini
+:author: Eric C. Pellegrini
 '''

 import logging

--- a/MDANSE/App/GUI/Framework/Plugins/AnimationPlugin.py
+++ b/MDANSE/App/GUI/Framework/Plugins/AnimationPlugin.py
@@ -27,7 +27,7 @@
 ''' 
 Created on Apr 14, 2015

-@author: Eric C. pellegrini
+:author: Eric C. Pellegrini
 '''

 import wx

--- a/MDANSE/App/GUI/Framework/Plugins/AtomSelectionPlugin.py
+++ b/MDANSE/App/GUI/Framework/Plugins/AtomSelectionPlugin.py
@@ -27,7 +27,7 @@
 ''' 
 Created on Apr 14, 2015

-@author: Eric C. Pellegrini
+:author: Eric C. Pellegrini
 '''

 import collections

--- a/MDANSE/App/GUI/Framework/Plugins/AtomTransmutationPlugin.py
+++ b/MDANSE/App/GUI/Framework/Plugins/AtomTransmutationPlugin.py
@@ -27,7 +27,7 @@
 ''' 
 Created on Apr 14, 2015

-@author: Eric C. Pellegrini
+:author: Eric C. Pellegrini
 '''
 import os


--- a/MDANSE/App/GUI/Framework/Plugins/AxisSelectionPlugin.py
+++ b/MDANSE/App/GUI/Framework/Plugins/AxisSelectionPlugin.py
@@ -27,7 +27,7 @@
 ''' 
 Created on Apr 14, 2015

-@author: pellegrini
+:author: Eric C. Pellegrini
 '''

 import os

--- a/MDANSE/App/GUI/Framework/Plugins/BasisSelectionPlugin.py
+++ b/MDANSE/App/GUI/Framework/Plugins/BasisSelectionPlugin.py
@@ -27,7 +27,7 @@
 ''' 
 Created on Apr 14, 2015

-@author: pellegrini
+:author: Eric C. Pellegrini
 '''

 import os

--- a/MDANSE/App/GUI/Framework/Plugins/ComponentPlugin.py
+++ b/MDANSE/App/GUI/Framework/Plugins/ComponentPlugin.py
@@ -27,7 +27,7 @@
 ''' 
 Created on Mar 30, 2015

-@author: Gael Goret, Eric C. Pellegrini
+:author: Gael Goret, Eric C. Pellegrini
 '''

 from MDANSE.App.GUI.Framework.Plugins.IPlugin import IPlugin 

--- a/MDANSE/App/GUI/Framework/Plugins/DataInfoPlugin.py
+++ b/MDANSE/App/GUI/Framework/Plugins/DataInfoPlugin.py
@@ -27,7 +27,7 @@
 ''' 
 Created on Apr 14, 2015

-@author: pellegrini
+:author: Eric C. Pellegrini
 '''

 import wx

--- a/MDANSE/App/GUI/Framework/Plugins/DataPlugin.py
+++ b/MDANSE/App/GUI/Framework/Plugins/DataPlugin.py
@@ -27,7 +27,7 @@
 ''' 
 Created on Mar 30, 2015

-@author: Gael Goret, Eric C. Pellegrini
+:author: Gael Goret, Eric C. Pellegrini
 '''

 import wx

--- a/MDANSE/App/GUI/Framework/Plugins/DensitySuperpositionPlugin.py
+++ b/MDANSE/App/GUI/Framework/Plugins/DensitySuperpositionPlugin.py
@@ -27,7 +27,7 @@
 ''' 
 Created on Apr 14, 2015

-@author: pellegrini
+:author: Eric C. Pellegrini
 '''

 import wx

--- a/MDANSE/App/GUI/Framework/Plugins/EmptyDataPlugin.py
+++ b/MDANSE/App/GUI/Framework/Plugins/EmptyDataPlugin.py
@@ -27,7 +27,7 @@
 ''' 
 Created on Apr 14, 2015

-@author: pellegrini
+:author: Eric C. Pellegrini
 '''

 from MDANSE.App.GUI.Framework.Plugins.DataPlugin import DataPlugin

--- a/MDANSE/App/GUI/Framework/Plugins/IPlugin.py
+++ b/MDANSE/App/GUI/Framework/Plugins/IPlugin.py
@@ -27,7 +27,7 @@
 ''' 
 Created on Mar 30, 2015

-@author: Gael Goret, Eric C. Pellegrini
+:author: Gael Goret, Eric C. Pellegrini
 '''

 import abc

--- a/MDANSE/App/GUI/Framework/Plugins/JobPlugin.py
+++ b/MDANSE/App/GUI/Framework/Plugins/JobPlugin.py
@@ -27,7 +27,7 @@
 ''' 
 Created on Apr 14, 2015

-@author: Eric C. ellegrini
+:author: Eric C. ellegrini
 '''

 import os

--- a/MDANSE/App/GUI/Framework/Plugins/MolecularViewerPlugin.py
+++ b/MDANSE/App/GUI/Framework/Plugins/MolecularViewerPlugin.py
@@ -27,7 +27,7 @@
 ''' 
 Created on Apr 14, 2015

-@author: Gael Goret, Bachir Aoun, Eric C. Pellegrini
+:author: Gael Goret, Bachir Aoun, Eric C. Pellegrini
 '''

 import numpy

--- a/MDANSE/App/GUI/Framework/Plugins/MviViewerPlugin.py
+++ b/MDANSE/App/GUI/Framework/Plugins/MviViewerPlugin.py
@@ -27,7 +27,7 @@
 ''' 
 Created on Apr 15, 2015

-@author: Gael Goret
+:author: Gael Goret
 '''

 import numpy

--- a/MDANSE/App/GUI/Framework/Plugins/PeriodicTablePlugin.py
+++ b/MDANSE/App/GUI/Framework/Plugins/PeriodicTablePlugin.py
@@ -27,7 +27,7 @@
 ''' 
 Created on Apr 14, 2015

-@author: Eric C. pellegrini
+:author: Eric C. Pellegrini
 '''

 import os

--- a/MDANSE/App/GUI/Framework/Plugins/Plotter/Plotter1D.py
+++ b/MDANSE/App/GUI/Framework/Plugins/Plotter/Plotter1D.py
@@ -27,7 +27,7 @@
 ''' 
 Created on Apr 10, 2015

-@author: Gael Goret, Bachir Aoun, Eric C. Pellegrini
+:author: Gael Goret, Bachir Aoun, Eric C. Pellegrini
 '''

 import os

--- a/MDANSE/App/GUI/Framework/Plugins/Plotter/Plotter2D.py
+++ b/MDANSE/App/GUI/Framework/Plugins/Plotter/Plotter2D.py
@@ -27,7 +27,7 @@
 ''' 
 Created on Apr 10, 2015

-@author: Gael Goret, Bachir Aoun, Eric C. Pellegrini
+:author: Gael Goret, Bachir Aoun, Eric C. Pellegrini
 '''

 import collections

--- a/MDANSE/App/GUI/Framework/Plugins/Plotter/Plotter3D.py
+++ b/MDANSE/App/GUI/Framework/Plugins/Plotter/Plotter3D.py
@@ -27,7 +27,7 @@
 ''' 
 Created on Apr 10, 2015

-@author: Gael Goret, Eric C. Pellegrini
+:author: Gael Goret, Eric C. Pellegrini
 '''

 import os

--- a/MDANSE/App/GUI/Framework/Plugins/Plotter/PlotterPlugin.py
+++ b/MDANSE/App/GUI/Framework/Plugins/Plotter/PlotterPlugin.py
@@ -27,7 +27,7 @@
 ''' 
 Created on Apr 10, 2015

-@author: Gael Goret and Eric C. Pellegrini
+:author: Gael Goret and Eric C. Pellegrini
 '''

 import collections

--- a/MDANSE/App/GUI/Framework/Plugins/Plotter/Settings.py
+++ b/MDANSE/App/GUI/Framework/Plugins/Plotter/Settings.py
@@ -27,7 +27,7 @@
 ''' 
 Created on Apr 10, 2015

-@author: Gael Goret
+:author: Gael Goret
 '''

 import matplotlib

--- a/MDANSE/App/GUI/Framework/Plugins/Plotter/Ticker.py
+++ b/MDANSE/App/GUI/Framework/Plugins/Plotter/Ticker.py
@@ -27,7 +27,7 @@
 ''' 
 Created on Apr 13, 2015

-@author: Gael Goret, Eric C. Pellegrini
+:author: Gael Goret, Eric C. Pellegrini
 '''

 import matplotlib.ticker

--- a/MDANSE/App/GUI/Framework/Plugins/QVectorsPlugin.py
+++ b/MDANSE/App/GUI/Framework/Plugins/QVectorsPlugin.py
@@ -27,7 +27,7 @@
 ''' 
 Created on Apr 14, 2015

-@author: Eric C. pellegrini
+:author: Eric C. Pellegrini
 '''

 import os

--- a/MDANSE/App/GUI/Framework/Plugins/RegistryViewerPlugin.py
+++ b/MDANSE/App/GUI/Framework/Plugins/RegistryViewerPlugin.py
@@ -27,7 +27,7 @@
 ''' 
 Created on Apr 14, 2015

-@author: Gael Goret, Eric C. pellegrini
+:author: Gael Goret, Eric C. Pellegrini
 '''

 import wx

--- a/MDANSE/App/GUI/Framework/Plugins/UserDefinitionViewerPlugin.py
+++ b/MDANSE/App/GUI/Framework/Plugins/UserDefinitionViewerPlugin.py
@@ -27,7 +27,7 @@
 ''' 
 Created on Apr 14, 2015

-@author: Gael Goret and Eric C. Pellegrini
+:author: Gael Goret and Eric C. Pellegrini
 '''

 import wx

--- a/MDANSE/App/GUI/Framework/Widgets/AtomSelectionWidget.py
+++ b/MDANSE/App/GUI/Framework/Widgets/AtomSelectionWidget.py
@@ -27,7 +27,7 @@
 ''' 
 Created on Mar 30, 2015

-@author: pellegrini
+:author: Eric C. Pellegrini
 '''

 from MDANSE.Externals.pubsub import pub

--- a/MDANSE/App/GUI/Framework/Widgets/AtomTransmutationWidget.py
+++ b/MDANSE/App/GUI/Framework/Widgets/AtomTransmutationWidget.py
@@ -27,7 +27,7 @@
 ''' 
 Created on Mar 30, 2015

-@author: pellegrini
+:author: Eric C. Pellegrini
 '''

 from MDANSE.Externals.pubsub import pub

--- a/MDANSE/App/GUI/Framework/Widgets/AxisSelectionWidget.py
+++ b/MDANSE/App/GUI/Framework/Widgets/AxisSelectionWidget.py
@@ -27,7 +27,7 @@
 ''' 
 Created on Mar 30, 2015

-@author: pellegrini
+:author: Eric C. Pellegrini
 '''

 from MDANSE.Externals.pubsub import pub

--- a/MDANSE/App/GUI/Framework/Widgets/BasisSelectionWidget.py
+++ b/MDANSE/App/GUI/Framework/Widgets/BasisSelectionWidget.py
@@ -27,7 +27,7 @@
 ''' 
 Created on Mar 30, 2015

-@author: pellegrini
+:author: Eric C. Pellegrini
 '''

 from MDANSE.Externals.pubsub import pub

--- a/MDANSE/App/GUI/Framework/Widgets/BooleanWidget.py
+++ b/MDANSE/App/GUI/Framework/Widgets/BooleanWidget.py
@@ -27,7 +27,7 @@
 ''' 
 Created on Mar 30, 2015

-@author: pellegrini
+:author: Eric C. Pellegrini
 '''

 import wx

--- a/MDANSE/App/GUI/Framework/Widgets/FloatWidget.py
+++ b/MDANSE/App/GUI/Framework/Widgets/FloatWidget.py
@@ -27,7 +27,7 @@
 ''' 
 Created on Mar 30, 2015

-@author: pellegrini
+:author: Eric C. Pellegrini
 '''

 import wx

--- a/MDANSE/App/GUI/Framework/Widgets/FramesWidget.py
+++ b/MDANSE/App/GUI/Framework/Widgets/FramesWidget.py
@@ -27,7 +27,7 @@
 ''' 
 Created on Mar 30, 2015

-@author: pellegrini
+:author: Eric C. Pellegrini
 '''

 import wx

--- a/MDANSE/App/GUI/Framework/Widgets/GroupingLevelWidget.py
+++ b/MDANSE/App/GUI/Framework/Widgets/GroupingLevelWidget.py
@@ -27,7 +27,7 @@
 ''' 
 Created on Mar 30, 2015

-@author: pellegrini
+:author: Eric C. Pellegrini
 '''

 from MDANSE.App.GUI.Framework.Widgets.SingleChoiceWidget import SingleChoiceWidget

--- a/MDANSE/App/GUI/Framework/Widgets/IWidget.py
+++ b/MDANSE/App/GUI/Framework/Widgets/IWidget.py
@@ -27,7 +27,7 @@
 ''' 
 Created on Mar 30, 2015

-@author: pellegrini
+:author: Eric C. Pellegrini
 '''

 import abc

--- a/MDANSE/App/GUI/Framework/Widgets/InputDirectoryWidget.py
+++ b/MDANSE/App/GUI/Framework/Widgets/InputDirectoryWidget.py
@@ -27,7 +27,7 @@
 ''' 
 Created on Mar 30, 2015

-@author: pellegrini
+:author: Eric C. Pellegrini
 '''

 import wx

--- a/MDANSE/App/GUI/Framework/Widgets/InputFileWidget.py
+++ b/MDANSE/App/GUI/Framework/Widgets/InputFileWidget.py
@@ -27,7 +27,7 @@
 ''' 
 Created on Mar 30, 2015

-@author: pellegrini
+:author: Eric C. Pellegrini
 '''
        
 import wx

--- a/MDANSE/App/GUI/Framework/Widgets/InstrumentResolutionWidget.py
+++ b/MDANSE/App/GUI/Framework/Widgets/InstrumentResolutionWidget.py
@@ -27,7 +27,7 @@
 ''' 
 Created on Mar 30, 2015

-@author: pellegrini
+:author: Eric C. Pellegrini
 '''

 import numpy

--- a/MDANSE/App/GUI/Framework/Widgets/IntegerWidget.py
+++ b/MDANSE/App/GUI/Framework/Widgets/IntegerWidget.py
@@ -27,7 +27,7 @@
 ''' 
 Created on Mar 30, 2015

-@author: pellegrini
+:author: Eric C. Pellegrini
 '''

 import wx

--- a/MDANSE/App/GUI/Framework/Widgets/InterpolationOrderWidget.py
+++ b/MDANSE/App/GUI/Framework/Widgets/InterpolationOrderWidget.py
@@ -27,7 +27,7 @@
 ''' 
 Created on Mar 30, 2015

-@author: pellegrini
+:author: Eric C. Pellegrini
 '''

 import wx

--- a/MDANSE/App/GUI/Framework/Widgets/MMTKTrajectoryWidget.py
+++ b/MDANSE/App/GUI/Framework/Widgets/MMTKTrajectoryWidget.py
@@ -27,7 +27,7 @@
 ''' 
 Created on Mar 30, 2015

-@author: pellegrini
+:author: Eric C. Pellegrini
 '''

 import wx

--- a/MDANSE/App/GUI/Framework/Widgets/McStasInstrumentWidget.py
+++ b/MDANSE/App/GUI/Framework/Widgets/McStasInstrumentWidget.py
@@ -27,7 +27,7 @@
 ''' 
 Created on Mar 30, 2015

-@author: pellegrini
+:author: Eric C. Pellegrini
 '''

 import os

--- a/MDANSE/App/GUI/Framework/Widgets/McStasOptionsWidget.py
+++ b/MDANSE/App/GUI/Framework/Widgets/McStasOptionsWidget.py
@@ -27,7 +27,7 @@
 ''' 
 Created on Mar 30, 2015

-@author: pellegrini
+:author: Eric C. Pellegrini
 '''

 import wx

--- a/MDANSE/App/GUI/Framework/Widgets/McStasParametersWidget.py
+++ b/MDANSE/App/GUI/Framework/Widgets/McStasParametersWidget.py
@@ -27,7 +27,7 @@
 ''' 
 Created on Mar 30, 2015
 
-@author: pellegrini
+:author: Eric C. Pellegrini
 '''
 
 import wx

--- a/MDANSE/App/GUI/Framework/Widgets/MultipleChoicesWidget.py
+++ b/MDANSE/App/GUI/Framework/Widgets/MultipleChoicesWidget.py
@@ -27,7 +27,7 @@
 ''' 
 Created on Mar 30, 2015

-@author: pellegrini
+:author: Eric C. Pellegrini
 '''

 import wx.combo

--- a/MDANSE/App/GUI/Framework/Widgets/NetCDFInputFileWidget.py
+++ b/MDANSE/App/GUI/Framework/Widgets/NetCDFInputFileWidget.py
@@ -27,7 +27,7 @@
 ''' 
 Created on Mar 30, 2015

-@author: pellegrini
+:author: Eric C. Pellegrini
 '''

 import wx

--- a/MDANSE/App/GUI/Framework/Widgets/OutputDirectoryWidget.py
+++ b/MDANSE/App/GUI/Framework/Widgets/OutputDirectoryWidget.py
@@ -27,7 +27,7 @@
 ''' 
 Created on Mar 30, 2015

-@author: pellegrini
+:author: Eric C. Pellegrini
 '''

 from MDANSE.App.GUI.Framework.Widgets.InputDirectoryWidget import InputDirectoryWidget

--- a/MDANSE/App/GUI/Framework/Widgets/OutputFilesWidget.py
+++ b/MDANSE/App/GUI/Framework/Widgets/OutputFilesWidget.py
@@ -27,7 +27,7 @@
 ''' 
 Created on Mar 30, 2015

-@author: pellegrini
+:author: Eric C. Pellegrini
 '''

 import os

--- a/MDANSE/App/GUI/Framework/Widgets/ProjectionWidget.py
+++ b/MDANSE/App/GUI/Framework/Widgets/ProjectionWidget.py
@@ -27,7 +27,7 @@
 ''' 
 Created on Mar 30, 2015

-@author: pellegrini
+:author: Eric C. Pellegrini
 '''

 import wx

--- a/MDANSE/App/GUI/Framework/Widgets/PythonObjectWidgets.py
+++ b/MDANSE/App/GUI/Framework/Widgets/PythonObjectWidgets.py
@@ -27,7 +27,7 @@
 ''' 
 Created on Mar 30, 2015

-@author: pellegrini
+:author: Eric C. Pellegrini
 '''

 import ast

--- a/MDANSE/App/GUI/Framework/Widgets/QVectorsWidget.py
+++ b/MDANSE/App/GUI/Framework/Widgets/QVectorsWidget.py
@@ -27,7 +27,7 @@
 ''' 
 Created on Mar 30, 2015

-@author: pellegrini
+:author: Eric C. Pellegrini
 '''

 from MDANSE.Externals.pubsub import pub

--- a/MDANSE/App/GUI/Framework/Widgets/RangeWidget.py
+++ b/MDANSE/App/GUI/Framework/Widgets/RangeWidget.py
@@ -27,7 +27,7 @@
 ''' 
 Created on Mar 30, 2015

-@author: pellegrini
+:author: Eric C. Pellegrini
 '''

 import wx

--- a/MDANSE/App/GUI/Framework/Widgets/RunningModeWidget.py
+++ b/MDANSE/App/GUI/Framework/Widgets/RunningModeWidget.py
@@ -27,7 +27,7 @@
 ''' 
 Created on Mar 30, 2015

-@author: pellegrini
+:author: Eric C. Pellegrini
 '''