config.ini

[GLOBAL]
# global variables used in scripts
DIRNAME=ref
LIBRARY_DIRNAME=python

[DIRNAMES_TO_TITLES]
# key-value map taking directory names to their titles in the Gitbook sidebar
#  auto-generated dirname/title maps are added in scripts
ref=Reference
cli=Command Line Interface
python=Python Library
data-types=Data Types
public-api=Import & Export API
integrations=Integrations
launch=Launch
keras=Keras
weave=Weave

[SKIPS]
# subdirectories of ref/ to skip when creating table of contents/SUMMARY.md
elements=app

[EXTERNAL]
# the content of these directories is generated from outside of docugen,
# so they should not be erased on startup, but they _do_ need to be walked.
elements=weave

###
#
# SUBCONFIGurations for doc generation in each "module"
#
###

[EXAMPLE_SUBCONFIG]
# an example subconfig, all fields are mandatory but some can be empty
#  see library.py for how these fields are used
dirname=name-of-directory-for-this
title=Human Readable Title for Sidebar
slug=prefix.for.markdown.filename.
elements=python,objects,that,you,want,to,document,commmaseparated
# see handle_additions in library.py for use of add-from and add-elements
add-from=submodule.toadd.elementsfrom
add-elements=elements,from,that,submodule
# see get_dunder_doc in library.py for use of module-doc-from
module-doc-from=other.module.with.dunderdoc

[SUBCONFIGS]
# add your subconfig's name here to document a new module
names=WANDB_CORE,WANDB_DATATYPES,WANDB_API,WANDB_INTEGRATIONS,WANDB_LAUNCH

[WANDB_CORE]
# main python SDK library
dirname=python
title=Python Library
slug=wandb.
elements=Artifact,agent,config,controller,finish,init,log,login,save,summary,sweep,watch,__version__
;elements=Run
add-from=wandb_sdk.wandb_run
add-elements=Run
module-doc-from=self

[WANDB_DATATYPES]
# data types submodule, including media and tables
dirname=data-types
title=Data Types
slug=wandb.data\_types.
elements=Graph,Image,Plotly,Video,Audio,Table,Html,Object3D,Molecule,Histogram
add-from=data_types
add-elements=ImageMask,BoundingBoxes2D,WBTraceTree
module-doc-from=data_types

[WANDB_API]
# public API subdmodule
dirname=public-api
title=Import & Export API
slug=wandb.apis.public.
elements=
add-from=apis.public
add-elements=Api,Projects,Project,Runs,Run,Sweep,Files,File,RunQueue,Job,QueuedRun
module-doc-from=apis.public

[WANDB_INTEGRATIONS]
# integrations with other libraries that we host the code for
dirname=integrations
title=Integrations
# slugs for integrations are handled differently, see generate.py
slug=wandb.
elements=keras
add-from=
add-elements=ValidationDataLogger
module-doc-from=


[WANDB_LAUNCH]
# launch ref code
dirname=launch-library
title=Launch
slug=wandb.sdk.
elements=
add-from=wandb.sdk.launch
add-elements=launch,launch_add,LaunchAgent
module-doc-from=