quartodoc
Get Started
Examples
Tutorials
Reference
API Builders
Builder.write_index
Function reference
Preparation Functions
Auto
blueprint
collect
get_object
preview
Docstring Renderers
MdRenderer
MdRenderer.render
MdRenderer.render_annotation
MdRenderer.render_header
MdRenderer.signature
MdRenderer.summarize
API Builders
Builder
Builder.from_quarto_config
Builder.build
Builder.write_index
Builder.write_doc_pages
Builder.write_sidebar
Builder.create_inventory
Inventory links
create_inventory
convert_inventory
Data models
Structural
layout.Layout
layout.Section
layout.Page
layout.SectionElement
layout.ContentElement
Docable
layout.Doc
layout.DocFunction
layout.DocAttribute
layout.DocModule
layout.DocClass
layout.Link
layout.Item
layout.ChoicesChildren
Docstring patches
ast.DocstringSectionSeeAlso
ast.DocstringSectionNotes
ast.DocstringSectionWarnings
ast.ExampleCode
ast.ExampleText
On this page
Builder.write_index
Builder.write_index
Builder.write_index(blueprint)
Write API index page.
Builder.build
Builder.write_doc_pages