+ ~viRt^RIHt^RIt^RIHt^RIHt^RI H t H t ^RI H t ^RIHtRR ltR R ltR R ltRRltRRltRRRlltR#)aMachinery for documenting traitlets config options with Sphinx. This includes: - A Sphinx extension defining directives and roles for config options. - A function to generate an rst file given an Application instance. To make this documentation, first set this module as an extension in Sphinx's conf.py:: extensions = [ # ... 'traitlets.config.sphinxdoc', ] Autogenerate the config documentation by running code like this before Sphinx builds:: from traitlets.config.sphinxdoc import write_doc from myapp import MyApplication writedoc('config/options.rst', # File to write 'MyApp config options', # Title MyApplication() ) The generated rST syntax looks like this:: .. configtrait:: Application.log_datefmt Description goes here. Cross reference like this: :configtrait:`Application.log_datefmt`. ) annotationsN) defaultdict)dedent) HasTraits Undefined) Application)indentc V^8dQhRRRR/#)appt.Anyreturndict[str, t.Any])formats"N-SV-rc ~.pVPp\VPRR7P44EFwrEVPPpVR,VP ;'gR,pVRV,R., pVP P4;'gRpVP\\V44R,4RV9dCVP\R R PR VP44,44M!VP\R V,44\VP4'diVP4p V eT\#V 4^@8dV R,R,p V P%RR4p VP\RV ,44W,'d3\'W,4p VP\RV ,44VPR4EK RPV4# \ dR p Li;i)zgGenerate rST documentation for this class' config options. Excludes traits defined on parent classes. T)config.z.. configtrait:: zNo description Enumz :options: r+c34"TFpRV,xK R#5i)z``%r``Nr).0xs& r 'class_config_rst_doc..[s8\|!A|sz :trait type: N:N=Nz...z\nz\\nz:default: ``%s``z :CLI option: )__name__sorted class_traitsitems __class__namehelprstripr-rrr.valuesr% default_valuedefault_value_repr Exceptionr,replacer2) r4r5lines classname_traitttypefullnamerHdvr fmt_aliasess && rclass_config_rst_docrWHs E I3++4+8>>@A((s?ejj&6&6B7 %0"55zz  "66&6 VF4L)D01 U? LL tyy8\u||8\/\ \] ^ LL% 78 9 %U%8%8 9 9 ..0s8b=c(U*Ckk%1 V$6$<=>  " "()@AK LL+ => ?  RIBL 99U #  sH,, H<;H<c V^8dQhRRRR/#)r r rr zdict[str, list[str]]r)rs"rrrxs)=rc\\4pVPP4Fwr#W,P V4K VP P4FwpwrV\ V4^8XgK\\V44pWW,p\ V4^8XgKH\\V44p W,RJgKjWR,V ,,P V4K V#)zBProduce a mapping of trait names to lists of command line aliases.Tr8) rr!r'rEr-flagsr,nextiter) r resaliasrRflagcfgrQrPcls_cfg traitnames & rreverse_aliasesrcxs d C ))+  % , ))//+hs s8q=T#YInG7|q  g/ %-C)34;;DA, Jrc ,V^8dQhRRRRRRRRRR /#) r pathr titler rpreamblez str | Noner Noner)rs"rrrs0C+W[rc \V4p\VR4;_uu_4pVPVR,4VPR\V4,R,4VPR4VeVPVR,4VP 4F.pVP\ Wd44VPR4K0 RRR4R# +'giR#;i)aaWrite a rst file documenting config options for a traitlets application. Parameters ---------- path : str The file to be written title : str The human-readable title of the document app : traitlets.config.Application An instance of the application class to be documented preamble : str Extra text to add just after the title (optional) wr:=Nz )rcopenwriter,_classes_inc_parentsrW)rerfr rgr5fcs&&&& r write_docrqs$C(M dCA   s5z!T)*    GGHv% &))+A GG(: ; GGDM, s B0C C+ )N)__doc__ __future__rtypingt collectionsrtextwrapr traitletsrrtraitlets.config.applicationrtraitlets.utils.textrrr%r2rWrcrqrrrr{sG!D##*4'E-`(r