fork/mons
git clone https://git.julia.blue/fork/mons
17b9303
main
1import copy 2 3from docutils .parsers .rst import directives 4from sphinx .application import Sphinx 5from sphinx .domains .python import PyAttribute 6from sphinx .ext import autodoc 7 8 9class ClassMembersDocumenter (autodoc .ClassDocumenter ): 10option_spec = { 11** autodoc .ClassDocumenter .option_spec , 12"skip_docstr" :directives .unchanged , 13 } 14objtype = "classmembers" 15 16def generate (self ,* args ,** kwargs )-> None : 17self .options ["members" ]= autodoc .ALL 18self .is_toplevel = not self .options .get ("classmembersdocumenter" ,False ) 19self .options ["classmembersdocumenter" ]= True 20self .doc_as_attr = False 21 22super ().generate (* args ,** kwargs ) 23 24if not self .is_toplevel : 25return 26 27result_strlist = self .directive .result 28 29result_strlist .trim_start (4 ) 30result_strlist .trim_left (3 ) 31 32s_drop = list () 33current_prefix = "" 34for i in range (len (result_strlist )): 35s :str = result_strlist [i ] 36 37if ".. py:classmembers::" in s : 38current_prefix = s .split ()[- 1 ]+ "." 39 40if ":value:" in s : 41s_drop .append (s ) 42continue 43 44if ":type:" in s and "~typing.Optional" in s : 45result_strlist [i ]= s .replace ("~typing.Optional[" ,"" )[:- 1 ] 46 47if ".. py:classmembersattribute::" in s : 48directive ,arguments = s .rstrip ().split ("::" ,maxsplit = 1 ) 49result_strlist [i ]= ( 50directive + ":: " + current_prefix + arguments .split ("." )[- 1 ] 51 ) 52 53for s in s_drop : 54result_strlist .remove (s ) 55 56def document_members (self ,all_members :bool = False ): 57objpath = self .objpath 58if not self .object .__init__ .__qualname__ .startswith (self .object .__qualname__ ): 59self .objpath = self .object .__init__ .__qualname__ .split ("." )[:- 1 ] 60 61super ().document_members (all_members ) 62 63self .objpath = objpath 64 65def add_content (self ,more_content )-> None : 66skip_docstr = self .options .get ("skip_docstr" ,None ) 67if skip_docstr and not (skip_docstr == "all" or self .is_toplevel ): 68super ().add_content (more_content ) 69 70def get_object_members (self ,want_all :bool )-> tuple [bool ,autodoc .ObjectMembers ]: 71t_del = list () 72for n ,m in self .object .__dict__ .items (): 73t = type (m ) 74if getattr (self .object ,t .__name__ ,None )== t : 75t_del .append (t .__name__ ) 76t = copy .copy (t ) 77t .__qualname__ = t .__qualname__ .replace (t .__name__ ,n ) 78t .__name__ = n 79setattr (self .object ,n ,t ) 80 81ret ,members = super ().get_object_members (want_all ) 82 83members = [(n ,m )for n ,m in members if n not in t_del ] 84return ret ,members 85 86def format_signature (self ,** kwargs )-> str : 87return "" 88 89 90class ClassMembersAttributeDocumenter (autodoc .AttributeDocumenter ): 91objtype = "classmembersattribute" 92 93def generate (self ,* args ,** kwargs )-> None : 94super ().generate (* args ,** kwargs ) 95 96def import_object (self ,raiseerror :bool = False )-> bool : 97ret = super ().import_object (raiseerror ) 98self .parent .__qualname__ = "." .join (self .objpath [:- 1 ]) 99return ret 100 101 102class PyClassMember (PyAttribute ): 103def get_signatures (self ): 104return [sig .split ("." )[- 1 ]for sig in super ().get_signatures ()] 105 106 107class ClassMembersDirective (PyClassMember ): 108option_spec = {** PyAttribute .option_spec ,"toplevel" :directives .unchanged } 109allow_nesting = True 110 111 112class AutoDocstr ( 113autodoc .ClassLevelDocumenter , 114autodoc .ModuleLevelDocumenter , 115autodoc .ModuleDocumenter , 116): 117objtype = "docstr" 118content_indent = "" 119 120@classmethod 121def can_document_member (cls ,* args ,** kwargs ): 122return False 123 124def add_line (self ,* args ,** kwargs )-> None : 125self .indent = "" 126return super ().add_line (* args ,** kwargs ) 127 128def resolve_name (self ,* args ,** kwargs ): 129module ,name = autodoc .ClassLevelDocumenter .resolve_name (self ,* args ,** kwargs ) 130 131if not module : 132module ,name = autodoc .ModuleLevelDocumenter .resolve_name ( 133self ,* args ,** kwargs 134 ) 135 136if not module : 137module ,name = autodoc .ClassLevelDocumenter .resolve_name ( 138self ,* args ,** kwargs 139 ) 140 141return module ,name 142 143def document_members (self ,all_members :bool = False )-> None : 144pass # skip 145 146def add_directive_header (self ,sig :str )-> None : 147pass # skip 148 149 150def setup (app :Sphinx ): 151app .add_autodocumenter (AutoDocstr ) 152app .add_autodocumenter (ClassMembersDocumenter ) 153app .add_autodocumenter (ClassMembersAttributeDocumenter ) 154app .add_directive_to_domain ("py" ,"classmembers" ,ClassMembersDirective ) 155app .add_directive_to_domain ("py" ,"classmembersattribute" ,PyClassMember )