I was able to accomplish what I wanted with the following
autodoc-process-signature event handler.
def autodocex_suppress_class_signature(app, what, name, obj, options,
signature, return_annotation):
if what in ('class',):
return ('','')
else:
return None
A much simpler solution than I was expecting.
________________________________
From: [email protected] <[email protected]> on behalf
of johna318 <[email protected]>
Sent: Sunday, January 27, 2019 2:30 PM
To: sphinx-users
Subject: [sphinx-users] Option to suppress class signatiure argument list
(everywhere)?
Is there a way to suppress the arguments and surrounding parens in class
signatures? I opt to document my class __init__ methods because I sometimes
have things to document that are specific to the method and are not pertinent
to the class as a whole or instances of it.
Also, I wold want the suppression of the class signature args to appear
everywhere, which I think implies that it should be reflected in the basic
doctree for the class.
Example:
What I get (preliminary docstrings):
class yunjing.YJTableDumpParams(shes=None, charts=None, columns=None,
rhymes=None, wholeChart=False, wholeToneBlock=False, wholeRow=False,
markNonmatchingSyllables=False, hideNonmatchingSyllables=False)[source]
Bases: object
Set of parameters that control outputting (“dumping”) of YJ Table
__init__(shes=None, charts=None, columns=None, rhymes=None,
wholeChart=False, wholeToneBlock=False, wholeRow=False,
markNonmatchingSyllables=False, hideNonmatchingSyllables=False)[source]
Initializes the following fields (based on existing comments):
shes=None, # list of shes - items can be any indexed sheInfo field
charts=None, # list of chartNums as ints
columns=None, # list of rowNums as ints
rhymes=None, # list of bestRhymes (characters) or bestRhymeLocs (form
#1-1 etc.)
wholeChart=False, # dump all cells in chart that contains at least one
specified rhyme, ignored if no rhymes specified - implies wholeToneBlock,
wholeRow
wholeToneBlock=False, # dump all cells in toneBlock that contains at
least one specified rhyme, ignored if no rhymes specified - implies wholeRow
wholeRow=False, # dump all cells in row that contains at least one
specified rhyme, ignored if no rhymes specified
markNonmatchingSyllables=False, # mark syllables whose rhymes are not
in the rhymes list
hideNonmatchingSyllables=False # hide syllables whose rhymes are not in
the rhymes list
What I want:
class yunjing.YJTableDumpParams [source] <---
Bases: object
Set of parameters that control outputting (“dumping”) of YJ Table
__init__(shes=None, charts=None, columns=None, rhymes=None,
wholeChart=False, wholeToneBlock=False, wholeRow=False,
markNonmatchingSyllables=False, hideNonmatchingSyllables=False)[source]
Initializes the following fields (based on existing comments):
shes=None, # list of shes - items can be any indexed sheInfo field
charts=None, # list of chartNums as ints
columns=None, # list of rowNums as ints
rhymes=None, # list of bestRhymes (characters) or bestRhymeLocs (form
#1-1 etc.)
<rest of params>
-- John
--
You received this message because you are subscribed to the Google Groups
"sphinx-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email
to
[email protected]<mailto:[email protected]>.
To post to this group, send email to
[email protected]<mailto:[email protected]>.
Visit this group at https://groups.google.com/group/sphinx-users.
For more options, visit https://groups.google.com/d/optout.
--
You received this message because you are subscribed to the Google Groups
"sphinx-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email
to [email protected].
To post to this group, send email to [email protected].
Visit this group at https://groups.google.com/group/sphinx-users.
For more options, visit https://groups.google.com/d/optout.
