|
3 | 3 |
|
4 | 4 | EXAMPLE_SECTIONS = [
|
5 | 5 | {'title': 'Preperation Functions',
|
6 |
| - 'desc': 'These functions fetch and analyze python objects, including parsing docstrings.\nThey prepare a basic representation of your doc site that can be rendered and built.\n', |
| 6 | + 'desc': 'Functions that fetch and analyze python objects.\nThey prepare a basic representation of your doc site.\n', |
7 | 7 | 'contents': ['Auto', 'blueprint', 'collect', 'get_object', 'preview']},
|
8 | 8 | {'title': 'Docstring Renderers',
|
9 | 9 | 'desc': 'Renderers convert parsed docstrings into a target format, like markdown.\n',
|
|
15 | 15 | {'name': 'MdRenderer.summarize', 'dynamic': True}]
|
16 | 16 | },
|
17 | 17 | {'title': 'API Builders',
|
18 |
| - 'desc': 'Builders are responsible for building documentation. They tie all the pieces\nof quartodoc together, and can be defined in your _quarto.yml config.\n', |
19 |
| - 'contents': [{'kind': 'auto', 'name': 'Builder', 'members': []}, |
20 |
| - 'Builder.from_quarto_config', 'Builder.build', 'Builder.write_index', 'Builder.write_doc_pages', 'Builder.write_sidebar', 'Builder.create_inventory'] |
| 18 | + 'desc': 'Builders are responsible for building documentation. They tie all the pieces\nof quartodoc together.\n', |
| 19 | + 'contents': [{'kind': 'auto', 'name': 'Builder', 'members': []}, |
| 20 | + 'Builder.from_quarto_config', 'Builder.build', 'Builder.write_index', 'Builder.write_doc_pages', 'Builder.write_sidebar', 'Builder.create_inventory'] |
21 | 21 | },
|
22 | 22 | ]
|
23 | 23 |
|
|
0 commit comments