o ȷeB@sjdZddlmZddlmZddlmZddlmZddZ dd Z d d Z d d Z ddZ dddZdS)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`. ) defaultdict)dedent) Undefined)indentcCs|jddddddd}|S)zRegisters the Sphinx extension. You shouldn't need to call this directly; configure Sphinx to use this module instead. configtraitz Config option)objnameT)parallel_read_safeparallel_write_safe)add_object_type)appmetadatar Q/var/www/ideatree/venv/lib/python3.10/site-packages/traitlets/config/sphinxdoc.pysetup*s rcCs4|dus|tur dSt|tttttfrt|SdS)NFT)r isinstancestrlisttupledictsetbool)dvr r rinteresting_default_value5s rcCsBg}|D]}t|dkrdnd}|d||dqd|S)N-z--z``, )lenappendjoin)aliasesfmtedadashesr r rformat_aliases=s  r#c Cs\g}|j}t|jddD]\}}|jj}|d|j}|d|dg7}|jp,d}|t t |dd|vrO|t d d d d |j Dn |t d |t |jrz|} Wn tynd} Ynw| durt| dkr| ddd} | dd} |t d| ||rt||} |t d| |dqd |S)zoGenerate rST documentation for this class' config options. Excludes traits defined on parent classes. T)config.z.. configtrait:: zNo description Enumz :options: rcss|]}d|VqdS)z``%r``Nr ).0xr r r Xsz'class_config_rst_doc..z :trait type: N@=z...z\nz\\nz:default: ``%s``z :CLI option: )__name__sorted class_traitsitems __class__namehelprstriprrrrvaluesr default_valuedefault_value_repr Exceptionrreplacer#) cls trait_aliaseslines classname_traitttypefullnamer4dvr fmt_aliasesr r rclass_config_rst_docEs6&        rEc Cstt}|jD] \}}|||q |jD]3\}\}}t|dkrMt|d}||}t|dkrMt|d} || durM||d| |q|S)zBProduce a mapping of trait names to lists of command line aliases.rrTr%)rrrr1rflagsr) r resaliasr@flagcfgr?r>cls_cfg traitnamer r rreverse_aliasesus     rMNcCst|}t|d?}||d|dt|d|d|dur,||d|D]}|t|||dq0WddS1sKwYdS)aWrite 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 )rMopenwriter_classes_inc_parentsrE)pathtitler preambler<fcr r r write_docs    "rX)N)__doc__ collectionsrtextwrapr traitletsrtraitlets.utils.textrrrr#rErMrXr r r rs "    0