Are you setting the autodoc flag? This is how I set it up at Eurocom.
-Dave On Tue, Jan 28, 2014 at 8:59 PM, Mark Jackson <[email protected]> wrote: > Sure, I'm only really just getting into it, looking at what we did at > Eurocom and taking it from there. I want to try and get a good standard > sorted before we push the same setups through our pipeline at work. > > class MetaClass(object): > > def __init__(self, node=None, name=None, nodeType='network', > autofill='all', **kws): > ''' > Base Class for Meta support. This manages all the attribute and > class > management for all subsequent inherited classes. > > :param node: Maya Node - if given we test it for the mClass > attribute, if it exists > we initialize a class of that type and return. If not > passed in then we > make a new network node for the type given. > :param name: only used on create, name to set for the new Maya > Node (self.mNode) > :param nodeType: allows you to specify a node of type to create as > a new mClass node. > default is 'network', not that for any node to show up in > the get > calls that type MUST be registered in the > RED9_META_NODETYPE_REGISTERY > :param autofill: 'str' cast all the MayaNode attrs into the class > dict by default. > Updated: modes: 'all' or 'messageOnly'. all casts every > attr, messageOnly > fills the node with just message linked attrs (designed > for MetaClass work > with HIK characterNode) > > .. note:: > > mNode is now a wrap on the MObject so will always be in sync > even if the node is renamed/parented > ''' > > kind of standard from what I can tell. I'll take a look at the decorator > stuff > > thanks > > > On 28 January 2014 20:38, Justin Israel <[email protected]> wrote: > >> Hey Mark, >> >> Can you post some examples of both your .rst and a class + docstring? >> >> I'm using sphinx for a few projects as well, and will use a mixture of >> both the autodoc features, and the manual stuff. The autodoc module/class >> features have properties that can control what it documents. In one of my >> projects many of the functions are decorated, but I am actually using >> autofunction on each one. >> >> Maybe this link is relevant? >> >> http://stackoverflow.com/questions/3687046/python-sphinx-autodoc-and-decorated-members >> >> >> >> -- justin >> >> >> >> >> On Wed, Jan 29, 2014 at 9:29 AM, Mark Jackson <[email protected]> wrote: >> >>> >>> I'm finally getting Sphinx hooked up to the Red9 api and had a few >>> questions to those of you running it in terms of formatting. >>> >>> Firstly any code I have that's decorated doesn't get documented other >>> than it's name, is there a trick or setting to get Sphinx to pass over the >>> decorator into the code itself? >>> >>> Secondly and I'm assuming there must be a way. In my function I'm doing >>> the standard :param name: etc which generates a big pink block of params >>> for the function, great, but these params are twice as bold as the >>> functions and class names themselves, how can I make sure that the class >>> header is boldest, and the function bold. Seems odd that the params come >>> out bolder and more obvious than the function they're describing. >>> >>> I'm assuming I'm missing a few things, only got this stuff running on >>> Saturday. >>> >>> thanks >>> >>> Mark >>> >>> >>> >>> ------------------------------------- >>> Mark Jackson >>> Technical Animation Director >>> http://markj3d.blogspot.com/ >>> >>> -- >>> You received this message because you are subscribed to the Google >>> Groups "Python Programming for Autodesk Maya" group. >>> To unsubscribe from this group and stop receiving emails from it, send >>> an email to [email protected]. >>> To view this discussion on the web visit >>> https://groups.google.com/d/msgid/python_inside_maya/CAGQH2FHmUKZG08EO_Vpyus73Rze%3DibNKnUd05ndS1ps%2BPSdmMQ%40mail.gmail.com >>> . >>> For more options, visit https://groups.google.com/groups/opt_out. >>> >> >> -- >> You received this message because you are subscribed to the Google Groups >> "Python Programming for Autodesk Maya" group. >> To unsubscribe from this group and stop receiving emails from it, send an >> email to [email protected]. >> To view this discussion on the web visit >> https://groups.google.com/d/msgid/python_inside_maya/CAPGFgA2Vow22SaX9S%3DZ0onRk6d9EyAdBFHxCphR4aW%2B65n39kQ%40mail.gmail.com >> . >> For more options, visit https://groups.google.com/groups/opt_out. >> > > > > -- > ------------------------------------- > Mark Jackson > Technical Animation Director > http://markj3d.blogspot.com/ > > -- > You received this message because you are subscribed to the Google Groups > "Python Programming for Autodesk Maya" group. > To unsubscribe from this group and stop receiving emails from it, send an > email to [email protected]. > To view this discussion on the web visit > https://groups.google.com/d/msgid/python_inside_maya/CAGQH2FFz3vZDRa_fNvT6eaudaLkAE1VWAF7sviXFO%3DsfvoCbwQ%40mail.gmail.com > . > > For more options, visit https://groups.google.com/groups/opt_out. > -- *David Moulder* Technical Animator / Artist [email protected] *Professional Profile <http://uk.linkedin.com/pub/david-moulder/1/b12/b5a>* Mobile: +44 (0)7814033242 See who we know in common<http://www.linkedin.com/e/wwk/5748982/?hs=false&tok=3tztwkse1silw1>Want a signature like this?<http://www.linkedin.com/e/sig/5748982/?hs=false&tok=3pwLU9-mBsilw1> -- You received this message because you are subscribed to the Google Groups "Python Programming for Autodesk Maya" group. To unsubscribe from this group and stop receiving emails from it, send an email to [email protected]. To view this discussion on the web visit https://groups.google.com/d/msgid/python_inside_maya/CABD4PkTJcaCsTFueh2tcmGTbqLocp2tPEWBAUajLTT0Q_DH%3DWA%40mail.gmail.com. For more options, visit https://groups.google.com/groups/opt_out.
