Commit 9f2e95dd authored by eric pellegrini's avatar eric pellegrini

Refactored the docstrings with correct author name

Bug fix that was making the sphinx-build very slow
parent 34e84eaa
......@@ -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)
......@@ -27,7 +27,7 @@
'''
Created on Apr 14, 2015
@author: pellegrini
:author: Eric C. Pellegrini
'''
import wx
......
......@@ -27,7 +27,7 @@
'''
Created on Apr 10, 2015
@author: pellegrini
:author: Eric C. Pellegrini
'''
import wx
......
......@@ -27,7 +27,7 @@
'''
Created on Apr 10, 2015
@author: pellegrini
:author: Eric C. Pellegrini
'''
import collections
......
......@@ -27,7 +27,7 @@
'''
Created on Apr 10, 2015
@author: pellegrini
:author: Eric C. Pellegrini
'''
import wx
......
......@@ -27,7 +27,7 @@
'''
Created on Apr 14, 2015
@author: pellegrini
:author: Eric C. Pellegrini
'''
import logging
......
......@@ -27,7 +27,7 @@
'''
Created on Apr 14, 2015
@author: pellegrini
:author: Eric C. Pellegrini
'''
import logging
......
......@@ -27,7 +27,7 @@
'''
Created on Apr 14, 2015
@author: Eric C. pellegrini
:author: Eric C. Pellegrini
'''
import wx
......
......@@ -27,7 +27,7 @@
'''
Created on Apr 14, 2015
@author: Eric C. Pellegrini
:author: Eric C. Pellegrini
'''
import collections
......
......@@ -27,7 +27,7 @@
'''
Created on Apr 14, 2015
@author: Eric C. Pellegrini
:author: Eric C. Pellegrini
'''
import os
......
......@@ -27,7 +27,7 @@
'''
Created on Apr 14, 2015
@author: pellegrini
:author: Eric C. Pellegrini
'''
import os
......
......@@ -27,7 +27,7 @@
'''
Created on Apr 14, 2015
@author: pellegrini
:author: Eric C. Pellegrini
'''
import os
......
......@@ -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
......
......@@ -27,7 +27,7 @@
'''
Created on Apr 14, 2015
@author: pellegrini
:author: Eric C. Pellegrini
'''
import wx
......
......@@ -27,7 +27,7 @@
'''
Created on Mar 30, 2015
@author: Gael Goret, Eric C. Pellegrini
:author: Gael Goret, Eric C. Pellegrini
'''
import wx
......
......@@ -27,7 +27,7 @@
'''
Created on Apr 14, 2015
@author: pellegrini
:author: Eric C. Pellegrini
'''
import wx
......
......@@ -27,7 +27,7 @@
'''
Created on Apr 14, 2015
@author: pellegrini
:author: Eric C. Pellegrini
'''
from MDANSE.App.GUI.Framework.Plugins.DataPlugin import DataPlugin
......
......@@ -27,7 +27,7 @@
'''
Created on Mar 30, 2015
@author: Gael Goret, Eric C. Pellegrini
:author: Gael Goret, Eric C. Pellegrini
'''
import abc
......
......@@ -27,7 +27,7 @@
'''
Created on Apr 14, 2015
@author: Eric C. ellegrini
:author: Eric C. ellegrini
'''
import os
......
......@@ -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
......
......@@ -27,7 +27,7 @@
'''
Created on Apr 15, 2015
@author: Gael Goret
:author: Gael Goret
'''
import numpy
......
......@@ -27,7 +27,7 @@
'''
Created on Apr 14, 2015
@author: Eric C. pellegrini
:author: Eric C. Pellegrini
'''
import os
......
......@@ -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
......
......@@ -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
......
......@@ -27,7 +27,7 @@
'''
Created on Apr 10, 2015
@author: Gael Goret, Eric C. Pellegrini
:author: Gael Goret, Eric C. Pellegrini
'''
import os
......
......@@ -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
......
......@@ -27,7 +27,7 @@
'''
Created on Apr 10, 2015
@author: Gael Goret
:author: Gael Goret
'''
import matplotlib
......
......@@ -27,7 +27,7 @@
'''
Created on Apr 13, 2015
@author: Gael Goret, Eric C. Pellegrini
:author: Gael Goret, Eric C. Pellegrini
'''
import matplotlib.ticker
......
......@@ -27,7 +27,7 @@
'''
Created on Apr 14, 2015
@author: Eric C. pellegrini
:author: Eric C. Pellegrini
'''
import os
......
......@@ -27,7 +27,7 @@
'''
Created on Apr 14, 2015
@author: Gael Goret, Eric C. pellegrini
:author: Gael Goret, Eric C. Pellegrini
'''
import wx
......
......@@ -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
......
......@@ -27,7 +27,7 @@
'''
Created on Mar 30, 2015
@author: pellegrini
:author: Eric C. Pellegrini
'''
from MDANSE.Externals.pubsub import pub
......
......@@ -27,7 +27,7 @@
'''
Created on Mar 30, 2015
@author: pellegrini
:author: Eric C. Pellegrini
'''
from MDANSE.Externals.pubsub import pub
......
......@@ -27,7 +27,7 @@
'''
Created on Mar 30, 2015
@author: pellegrini
:author: Eric C. Pellegrini
'''
from MDANSE.Externals.pubsub import pub
......
......@@ -27,7 +27,7 @@
'''
Created on Mar 30, 2015
@author: pellegrini
:author: Eric C. Pellegrini
'''
from MDANSE.Externals.pubsub import pub
......
......@@ -27,7 +27,7 @@
'''
Created on Mar 30, 2015
@author: pellegrini
:author: Eric C. Pellegrini
'''
import wx
......
......@@ -27,7 +27,7 @@
'''
Created on Mar 30, 2015
@author: pellegrini
:author: Eric C. Pellegrini
'''
import wx
......
......@@ -27,7 +27,7 @@
'''
Created on Mar 30, 2015
@author: pellegrini
:author: Eric C. Pellegrini
'''
import wx
......
......@@ -27,7 +27,7 @@
'''
Created on Mar 30, 2015
@author: pellegrini
:author: Eric C. Pellegrini
'''
from MDANSE.App.GUI.Framework.Widgets.SingleChoiceWidget import SingleChoiceWidget
......
......@@ -27,7 +27,7 @@
'''
Created on Mar 30, 2015
@author: pellegrini
:author: Eric C. Pellegrini
'''
import abc
......
......@@ -27,7 +27,7 @@
'''
Created on Mar 30, 2015
@author: pellegrini
:author: Eric C. Pellegrini
'''
import wx
......
......@@ -27,7 +27,7 @@
'''
Created on Mar 30, 2015
@author: pellegrini
:author: Eric C. Pellegrini
'''
import wx
......
......@@ -27,7 +27,7 @@
'''
Created on Mar 30, 2015
@author: pellegrini
:author: Eric C. Pellegrini
'''
import numpy
......
......@@ -27,7 +27,7 @@
'''
Created on Mar 30, 2015
@author: pellegrini
:author: Eric C. Pellegrini
'''
import wx
......
......@@ -27,7 +27,7 @@
'''
Created on Mar 30, 2015
@author: pellegrini
:author: Eric C. Pellegrini
'''
import wx
......
......@@ -27,7 +27,7 @@
'''
Created on Mar 30, 2015
@author: pellegrini
:author: Eric C. Pellegrini
'''
import wx
......
......@@ -27,7 +27,7 @@
'''
Created on Mar 30, 2015
@author: pellegrini
:author: Eric C. Pellegrini
'''
import os
......
......@@ -27,7 +27,7 @@
'''
Created on Mar 30, 2015
@author: pellegrini
:author: Eric C. Pellegrini
'''
import wx
......
......@@ -27,7 +27,7 @@
'''
Created on Mar 30, 2015
@author: pellegrini
:author: Eric C. Pellegrini
'''
import wx
......
......@@ -27,7 +27,7 @@
'''
Created on Mar 30, 2015
@author: pellegrini
:author: Eric C. Pellegrini
'''
import wx.combo
......
......@@ -27,7 +27,7 @@
'''
Created on Mar 30, 2015
@author: pellegrini
:author: Eric C. Pellegrini
'''
import wx
......
......@@ -27,7 +27,7 @@
'''
Created on Mar 30, 2015
@author: pellegrini
:author: Eric C. Pellegrini
'''
from MDANSE.App.GUI.Framework.Widgets.InputDirectoryWidget import InputDirectoryWidget
......
......@@ -27,7 +27,7 @@
'''
Created on Mar 30, 2015
@author: pellegrini
:author: Eric C. Pellegrini
'''
import os
......
......@@ -27,7 +27,7 @@
'''
Created on Mar 30, 2015
@author: pellegrini
:author: Eric C. Pellegrini
'''
import wx
......
......@@ -27,7 +27,7 @@
'''
Created on Mar 30, 2015
@author: pellegrini
:author: Eric C. Pellegrini
'''
import ast
......
......@@ -27,7 +27,7 @@
'''
Created on Mar 30, 2015
@author: pellegrini
:author: Eric C. Pellegrini
'''
from MDANSE.Externals.pubsub import pub
......
......@@ -27,7 +27,7 @@
'''
Created on Mar 30, 2015
@author: pellegrini
:author: Eric C. Pellegrini
'''
import wx
......
......@@ -27,7 +27,7 @@
'''
Created on Mar 30, 2015
@author: pellegrini
:author: Eric C. Pellegrini
'''