.gitignore
.ruffignore
CITATION.cff
LICENSE
MANIFEST.in
Makefile
README.md
ROADMAP.md
great-docs.yml
index.qmd
pyproject.toml
.github/CODE_OF_CONDUCT.md
.github/CONTRIBUTING.md
.github/SECURITY.md
.github/workflows/docs.yml
.github/workflows/test.yml
.vscode/settings.json
assets/api-reference-index.png
assets/class-page.png
assets/cli-page.png
assets/dark-mode.png
assets/favicon.svg
assets/great-docs-site.png
assets/logo-dark.svg
assets/logo.svg
assets/method-page.png
examples/README.md
examples/_quarto_example.yml
great_docs/__init__.py
great_docs/_directives.py
great_docs/_git.py
great_docs/_harper.py
great_docs/_lint.py
great_docs/_mermaid.py
great_docs/cli.py
great_docs/config.py
great_docs/contrast.py
great_docs/core.py
great_docs.egg-info/PKG-INFO
great_docs.egg-info/SOURCES.txt
great_docs.egg-info/dependency_links.txt
great_docs.egg-info/entry_points.txt
great_docs.egg-info/requires.txt
great_docs.egg-info/top_level.txt
great_docs/_qrenderer/__init__.py
great_docs/_qrenderer/_ast.py
great_docs/_qrenderer/_format.py
great_docs/_qrenderer/_globals.py
great_docs/_qrenderer/_md_renderer.py
great_docs/_qrenderer/_renderer.py
great_docs/_qrenderer/_rst_converters.py
great_docs/_qrenderer/_tools.py
great_docs/_qrenderer/_transformers.py
great_docs/_qrenderer/_type_checks.py
great_docs/_qrenderer/blueprint.py
great_docs/_qrenderer/introspection.py
great_docs/_qrenderer/inventory.py
great_docs/_qrenderer/layout.py
great_docs/_qrenderer/py.typed
great_docs/_qrenderer/typing.py
great_docs/_qrenderer/typing_information.py
great_docs/_qrenderer/_griffe/__init__.py
great_docs/_qrenderer/_griffe/dataclasses.py
great_docs/_qrenderer/_griffe/docstrings.py
great_docs/_qrenderer/_griffe/enumerations.py
great_docs/_qrenderer/_griffe/expressions.py
great_docs/_qrenderer/_render/__init__.py
great_docs/_qrenderer/_render/_label.py
great_docs/_qrenderer/_render/api_page.py
great_docs/_qrenderer/_render/base.py
great_docs/_qrenderer/_render/doc.py
great_docs/_qrenderer/_render/docattribute.py
great_docs/_qrenderer/_render/docclass.py
great_docs/_qrenderer/_render/docfunction.py
great_docs/_qrenderer/_render/docmodule.py
great_docs/_qrenderer/_render/extending.py
great_docs/_qrenderer/_render/html_table.py
great_docs/_qrenderer/_render/mixin_call.py
great_docs/_qrenderer/_render/mixin_members.py
great_docs/_qrenderer/_render/mixin_page.py
great_docs/_qrenderer/_render/reference_page.py
great_docs/_qrenderer/_render/reference_section.py
great_docs/_qrenderer/pandoc/__init__.py
great_docs/_qrenderer/pandoc/blocks.py
great_docs/_qrenderer/pandoc/components.py
great_docs/_qrenderer/pandoc/inlines.py
great_docs/assets/.gitignore
great_docs/assets/_renderer.py
great_docs/assets/announcement-banner.js
great_docs/assets/content-style.js
great_docs/assets/copy-code.js
great_docs/assets/copy-page.js
great_docs/assets/dark-mode-toggle.js
great_docs/assets/github-widget.js
great_docs/assets/github-workflow-template.yml
great_docs/assets/great-docs.scss
great_docs/assets/mermaid-renderer.js
great_docs/assets/navbar-style.js
great_docs/assets/page-metadata.js
great_docs/assets/post-render.py
great_docs/assets/reference-switcher.js
great_docs/assets/responsive-tables.js
great_docs/assets/ror-icon.svg
great_docs/assets/sidebar-filter.js
great_docs/assets/sidebar-wrap.js
great_docs/assets/theme-init.js
great_docs/assets/tooltips.js
great_docs/assets/video-embed.js
recipes/01-hide-internal-symbols.qmd
recipes/02-customize-api-organization.qmd
recipes/03-document-a-cli.qmd
recipes/04-cross-reference-items.qmd
recipes/05-add-custom-css.qmd
recipes/06-choose-gradient-theme.qmd
recipes/07-add-logo-favicon.qmd
recipes/08-customize-announcement-banner.qmd
recipes/09-write-effective-docstrings.qmd
recipes/10-add-images-diagrams.qmd
recipes/11-create-changelog.qmd
recipes/12-github-pages-ci.qmd
recipes/13-add-custom-domain.qmd
recipes/14-install-great-docs-skill.qmd
recipes/15-build-site-with-llm.qmd
recipes/16-customize-site-with-llm.qmd
recipes/17-understand-llms-txt.qmd
recipes/18-fix-common-build-errors.qmd
recipes/19-proofread-documentation.qmd
recipes/20-embed-videos.qmd
skills/great-docs/SKILL.md
skills/great-docs/assets/config-template.yaml
skills/great-docs/references/cli-reference.md
skills/great-docs/references/common-errors.md
skills/great-docs/references/config-reference.md
skills/great-docs/scripts/run-build.sh
skills/great-docs/scripts/setup-env.sh
test-packages/README.md
test-packages/build_state.py
test-packages/catalog.py
test-packages/render_all.py
test-packages/setup-test-packages.sh
test-packages/test-integration.sh
test-packages/test_manual.py
test-packages/synthetic/__init__.py
test-packages/synthetic/catalog.py
test-packages/synthetic/generator.py
test-packages/synthetic/configs/config_authors.yml
test-packages/synthetic/configs/config_cli.yml
test-packages/synthetic/configs/config_cosmo.yml
test-packages/synthetic/configs/config_display_name.yml
test-packages/synthetic/configs/config_full.yml
test-packages/synthetic/configs/config_funding.yml
test-packages/synthetic/configs/config_github_icon.yml
test-packages/synthetic/configs/config_google.yml
test-packages/synthetic/configs/config_low_threshold.yml
test-packages/synthetic/configs/config_no_darkmode.yml
test-packages/synthetic/configs/config_no_sidebar.yml
test-packages/synthetic/configs/config_no_source.yml
test-packages/synthetic/configs/config_numpy.yml
test-packages/synthetic/configs/config_source_title.yml
test-packages/synthetic/configs/config_sphinx.yml
test-packages/synthetic/configs/config_static.yml
test-packages/synthetic/specs/__init__.py
test-packages/synthetic/specs/gdtest_abstract_props.py
test-packages/synthetic/specs/gdtest_all_concat.py
test-packages/synthetic/specs/gdtest_all_private.py
test-packages/synthetic/specs/gdtest_announce_dict.py
test-packages/synthetic/specs/gdtest_announce_disabled.py
test-packages/synthetic/specs/gdtest_announce_simple.py
test-packages/synthetic/specs/gdtest_async_funcs.py
test-packages/synthetic/specs/gdtest_attribution_off.py
test-packages/synthetic/specs/gdtest_attribution_on.py
test-packages/synthetic/specs/gdtest_authors_multi.py
test-packages/synthetic/specs/gdtest_auto_discover.py
test-packages/synthetic/specs/gdtest_auto_exclude.py
test-packages/synthetic/specs/gdtest_autolink.py
test-packages/synthetic/specs/gdtest_badge_readme.py
test-packages/synthetic/specs/gdtest_big_class.py
test-packages/synthetic/specs/gdtest_cli_click.py
test-packages/synthetic/specs/gdtest_cli_name.py
test-packages/synthetic/specs/gdtest_cli_nested.py
test-packages/synthetic/specs/gdtest_config_all_on.py
test-packages/synthetic/specs/gdtest_config_changelog.py
test-packages/synthetic/specs/gdtest_config_combo_a.py
test-packages/synthetic/specs/gdtest_config_combo_b.py
test-packages/synthetic/specs/gdtest_config_combo_c.py
test-packages/synthetic/specs/gdtest_config_combo_d.py
test-packages/synthetic/specs/gdtest_config_combo_e.py
test-packages/synthetic/specs/gdtest_config_combo_f.py
test-packages/synthetic/specs/gdtest_config_display.py
test-packages/synthetic/specs/gdtest_config_exclude.py
test-packages/synthetic/specs/gdtest_config_extra_keys.py
test-packages/synthetic/specs/gdtest_config_minimal.py
test-packages/synthetic/specs/gdtest_config_parser.py
test-packages/synthetic/specs/gdtest_config_reference.py
test-packages/synthetic/specs/gdtest_config_sections.py
test-packages/synthetic/specs/gdtest_config_ug_list.py
test-packages/synthetic/specs/gdtest_config_ug_string.py
test-packages/synthetic/specs/gdtest_constants.py
test-packages/synthetic/specs/gdtest_context_mgr.py
test-packages/synthetic/specs/gdtest_dataclasses.py
test-packages/synthetic/specs/gdtest_decorators.py
test-packages/synthetic/specs/gdtest_deep_nesting.py
test-packages/synthetic/specs/gdtest_descriptors.py
test-packages/synthetic/specs/gdtest_display_authors.py
test-packages/synthetic/specs/gdtest_display_badges.py
test-packages/synthetic/specs/gdtest_display_funding.py
test-packages/synthetic/specs/gdtest_display_name.py
test-packages/synthetic/specs/gdtest_docstring_combo.py
test-packages/synthetic/specs/gdtest_docstring_examples.py
test-packages/synthetic/specs/gdtest_docstring_math.py
test-packages/synthetic/specs/gdtest_docstring_notes.py
test-packages/synthetic/specs/gdtest_docstring_references.py
test-packages/synthetic/specs/gdtest_docstring_seealso.py
test-packages/synthetic/specs/gdtest_docstring_tables.py
test-packages/synthetic/specs/gdtest_docstring_warnings.py
test-packages/synthetic/specs/gdtest_dunders.py
test-packages/synthetic/specs/gdtest_duplicate_all.py
test-packages/synthetic/specs/gdtest_dynamic_false.py
test-packages/synthetic/specs/gdtest_empty_module.py
test-packages/synthetic/specs/gdtest_enums.py
test-packages/synthetic/specs/gdtest_exceptions.py
test-packages/synthetic/specs/gdtest_exclude_cli.py
test-packages/synthetic/specs/gdtest_exclude_list.py
test-packages/synthetic/specs/gdtest_explicit_big_class.py
test-packages/synthetic/specs/gdtest_explicit_ref.py
test-packages/synthetic/specs/gdtest_extras_guide.py
test-packages/synthetic/specs/gdtest_flit.py
test-packages/synthetic/specs/gdtest_flit_enums.py
test-packages/synthetic/specs/gdtest_frozen_dc.py
test-packages/synthetic/specs/gdtest_full_extras.py
test-packages/synthetic/specs/gdtest_funding.py
test-packages/synthetic/specs/gdtest_generators.py
test-packages/synthetic/specs/gdtest_generics.py
test-packages/synthetic/specs/gdtest_github_contrib.py
test-packages/synthetic/specs/gdtest_github_icon.py
test-packages/synthetic/specs/gdtest_google.py
test-packages/synthetic/specs/gdtest_google_big_class.py
test-packages/synthetic/specs/gdtest_google_rich.py
test-packages/synthetic/specs/gdtest_google_seealso.py
test-packages/synthetic/specs/gdtest_gradient_both.py
test-packages/synthetic/specs/gdtest_gradient_dusk.py
test-packages/synthetic/specs/gdtest_gradient_honey.py
test-packages/synthetic/specs/gdtest_gradient_lilac.py
test-packages/synthetic/specs/gdtest_gradient_mint.py
test-packages/synthetic/specs/gdtest_gradient_mixed.py
test-packages/synthetic/specs/gdtest_gradient_navbar.py
test-packages/synthetic/specs/gdtest_gradient_no_dismiss.py
test-packages/synthetic/specs/gdtest_gradient_peach.py
test-packages/synthetic/specs/gdtest_gradient_prism.py
test-packages/synthetic/specs/gdtest_gradient_sky.py
test-packages/synthetic/specs/gdtest_gradient_slate.py
test-packages/synthetic/specs/gdtest_hatch.py
test-packages/synthetic/specs/gdtest_hatch_nodoc.py
test-packages/synthetic/specs/gdtest_header_file.py
test-packages/synthetic/specs/gdtest_header_list.py
test-packages/synthetic/specs/gdtest_header_text.py
test-packages/synthetic/specs/gdtest_hero_auto_logo.py
test-packages/synthetic/specs/gdtest_hero_basic.py
test-packages/synthetic/specs/gdtest_hero_custom.py
test-packages/synthetic/specs/gdtest_hero_disabled.py
test-packages/synthetic/specs/gdtest_hero_explicit_badges.py
test-packages/synthetic/specs/gdtest_hero_index_qmd.py
test-packages/synthetic/specs/gdtest_hero_no_logo.py
test-packages/synthetic/specs/gdtest_hero_readme_badges.py
test-packages/synthetic/specs/gdtest_hero_wordmark.py
test-packages/synthetic/specs/gdtest_homepage_ug.py
test-packages/synthetic/specs/gdtest_index_md.py
test-packages/synthetic/specs/gdtest_index_qmd.py
test-packages/synthetic/specs/gdtest_index_wins.py
test-packages/synthetic/specs/gdtest_interlinks_prose.py
test-packages/synthetic/specs/gdtest_jupyter_kernel.py
test-packages/synthetic/specs/gdtest_kitchen_sink.py
test-packages/synthetic/specs/gdtest_kitchen_sink_q.py
test-packages/synthetic/specs/gdtest_lib_layout.py
test-packages/synthetic/specs/gdtest_logo.py
test-packages/synthetic/specs/gdtest_long_docs.py
test-packages/synthetic/specs/gdtest_long_names.py
test-packages/synthetic/specs/gdtest_many_big_classes.py
test-packages/synthetic/specs/gdtest_many_exports.py
test-packages/synthetic/specs/gdtest_many_guides.py
test-packages/synthetic/specs/gdtest_math_docs.py
test-packages/synthetic/specs/gdtest_md_disabled.py
test-packages/synthetic/specs/gdtest_md_no_widget.py
test-packages/synthetic/specs/gdtest_minimal.py
test-packages/synthetic/specs/gdtest_mixed_docs.py
test-packages/synthetic/specs/gdtest_mixed_guide_ext.py
test-packages/synthetic/specs/gdtest_monorepo.py
test-packages/synthetic/specs/gdtest_multi_inherit.py
test-packages/synthetic/specs/gdtest_multi_module.py
test-packages/synthetic/specs/gdtest_name_mismatch.py
test-packages/synthetic/specs/gdtest_namespace.py
test-packages/synthetic/specs/gdtest_namespace_ug.py
test-packages/synthetic/specs/gdtest_navbar_color.py
test-packages/synthetic/specs/gdtest_navbar_color_dark.py
test-packages/synthetic/specs/gdtest_navbar_color_light.py
test-packages/synthetic/specs/gdtest_navbar_color_same.py
test-packages/synthetic/specs/gdtest_navbar_color_split.py
test-packages/synthetic/specs/gdtest_nested_class.py
test-packages/synthetic/specs/gdtest_no_all.py
test-packages/synthetic/specs/gdtest_no_darkmode.py
test-packages/synthetic/specs/gdtest_no_readme.py
test-packages/synthetic/specs/gdtest_nodoc.py
test-packages/synthetic/specs/gdtest_nodocs.py
test-packages/synthetic/specs/gdtest_numpy_rich.py
test-packages/synthetic/specs/gdtest_numpy_seealso_desc.py
test-packages/synthetic/specs/gdtest_overloads.py
test-packages/synthetic/specs/gdtest_parser_google.py
test-packages/synthetic/specs/gdtest_parser_sphinx.py
test-packages/synthetic/specs/gdtest_pdm.py
test-packages/synthetic/specs/gdtest_pdm_big_class.py
test-packages/synthetic/specs/gdtest_protocols.py
test-packages/synthetic/specs/gdtest_python_layout.py
test-packages/synthetic/specs/gdtest_readme_rst.py
test-packages/synthetic/specs/gdtest_reexports.py
test-packages/synthetic/specs/gdtest_ref_big_class.py
test-packages/synthetic/specs/gdtest_ref_explicit.py
test-packages/synthetic/specs/gdtest_ref_members_false.py
test-packages/synthetic/specs/gdtest_ref_mixed.py
test-packages/synthetic/specs/gdtest_ref_module_expand.py
test-packages/synthetic/specs/gdtest_ref_multi_big.py
test-packages/synthetic/specs/gdtest_ref_reorder.py
test-packages/synthetic/specs/gdtest_ref_sectioned.py
test-packages/synthetic/specs/gdtest_ref_single_section.py
test-packages/synthetic/specs/gdtest_ref_title.py
test-packages/synthetic/specs/gdtest_rst_caution.py
test-packages/synthetic/specs/gdtest_rst_danger.py
test-packages/synthetic/specs/gdtest_rst_deprecated.py
test-packages/synthetic/specs/gdtest_rst_important.py
test-packages/synthetic/specs/gdtest_rst_mixed_dirs.py
test-packages/synthetic/specs/gdtest_rst_note.py
test-packages/synthetic/specs/gdtest_rst_tip.py
test-packages/synthetic/specs/gdtest_rst_versionadded.py
test-packages/synthetic/specs/gdtest_rst_warning.py
test-packages/synthetic/specs/gdtest_sec_blog.py
test-packages/synthetic/specs/gdtest_sec_deep.py
test-packages/synthetic/specs/gdtest_sec_examples.py
test-packages/synthetic/specs/gdtest_sec_faq.py
test-packages/synthetic/specs/gdtest_sec_index_opt.py
test-packages/synthetic/specs/gdtest_sec_multi.py
test-packages/synthetic/specs/gdtest_sec_navbar_after.py
test-packages/synthetic/specs/gdtest_sec_recipes.py
test-packages/synthetic/specs/gdtest_sec_sidebar_single.py
test-packages/synthetic/specs/gdtest_sec_tutorials.py
test-packages/synthetic/specs/gdtest_sec_with_ref.py
test-packages/synthetic/specs/gdtest_sec_with_ug.py
test-packages/synthetic/specs/gdtest_seealso.py
test-packages/synthetic/specs/gdtest_seealso_desc.py
test-packages/synthetic/specs/gdtest_setup_cfg.py
test-packages/synthetic/specs/gdtest_setup_cfg_src.py
test-packages/synthetic/specs/gdtest_setup_py.py
test-packages/synthetic/specs/gdtest_setuptools_find.py
test-packages/synthetic/specs/gdtest_sidebar_disabled.py
test-packages/synthetic/specs/gdtest_sidebar_min_items.py
test-packages/synthetic/specs/gdtest_site_combo.py
test-packages/synthetic/specs/gdtest_skill_combo.py
test-packages/synthetic/specs/gdtest_skill_complex.py
test-packages/synthetic/specs/gdtest_skill_config.py
test-packages/synthetic/specs/gdtest_skill_curated.py
test-packages/synthetic/specs/gdtest_skill_default.py
test-packages/synthetic/specs/gdtest_skill_disabled.py
test-packages/synthetic/specs/gdtest_skill_rich.py
test-packages/synthetic/specs/gdtest_slots_class.py
test-packages/synthetic/specs/gdtest_small_class.py
test-packages/synthetic/specs/gdtest_source_branch.py
test-packages/synthetic/specs/gdtest_source_disabled.py
test-packages/synthetic/specs/gdtest_source_path.py
test-packages/synthetic/specs/gdtest_source_title.py
test-packages/synthetic/specs/gdtest_sphinx.py
test-packages/synthetic/specs/gdtest_sphinx_class_role.py
test-packages/synthetic/specs/gdtest_sphinx_exc_role.py
test-packages/synthetic/specs/gdtest_sphinx_func_role.py
test-packages/synthetic/specs/gdtest_sphinx_meth_role.py
test-packages/synthetic/specs/gdtest_sphinx_mixed_roles.py
test-packages/synthetic/specs/gdtest_sphinx_rich.py
test-packages/synthetic/specs/gdtest_src_big_class.py
test-packages/synthetic/specs/gdtest_src_explicit_ref.py
test-packages/synthetic/specs/gdtest_src_google_seealso.py
test-packages/synthetic/specs/gdtest_src_layout.py
test-packages/synthetic/specs/gdtest_src_legacy.py
test-packages/synthetic/specs/gdtest_src_no_all.py
test-packages/synthetic/specs/gdtest_stress_all_config.py
test-packages/synthetic/specs/gdtest_stress_all_docstr.py
test-packages/synthetic/specs/gdtest_stress_all_sections.py
test-packages/synthetic/specs/gdtest_stress_all_ug.py
test-packages/synthetic/specs/gdtest_stress_everything.py
test-packages/synthetic/specs/gdtest_stress_everything_q.py
test-packages/synthetic/specs/gdtest_theme_cerulean.py
test-packages/synthetic/specs/gdtest_theme_cosmo.py
test-packages/synthetic/specs/gdtest_theme_lumen.py
test-packages/synthetic/specs/gdtest_toc_depth.py
test-packages/synthetic/specs/gdtest_toc_disabled.py
test-packages/synthetic/specs/gdtest_toc_title.py
test-packages/synthetic/specs/gdtest_typed_containers.py
test-packages/synthetic/specs/gdtest_ug_auto.py
test-packages/synthetic/specs/gdtest_ug_combo.py
test-packages/synthetic/specs/gdtest_ug_custom_dir.py
test-packages/synthetic/specs/gdtest_ug_deep_nest.py
test-packages/synthetic/specs/gdtest_ug_explicit_order.py
test-packages/synthetic/specs/gdtest_ug_hyphen_dir.py
test-packages/synthetic/specs/gdtest_ug_many_pages.py
test-packages/synthetic/specs/gdtest_ug_mixed_ext.py
test-packages/synthetic/specs/gdtest_ug_no_frontmatter.py
test-packages/synthetic/specs/gdtest_ug_numbered.py
test-packages/synthetic/specs/gdtest_ug_sections_fm.py
test-packages/synthetic/specs/gdtest_ug_single_page.py
test-packages/synthetic/specs/gdtest_ug_subdir_numbered.py
test-packages/synthetic/specs/gdtest_ug_subdirs.py
test-packages/synthetic/specs/gdtest_ug_with_code.py
test-packages/synthetic/specs/gdtest_ug_with_images.py
test-packages/synthetic/specs/gdtest_unicode_docs.py
test-packages/synthetic/specs/gdtest_user_guide_auto.py
test-packages/synthetic/specs/gdtest_user_guide_cli.py
test-packages/synthetic/specs/gdtest_user_guide_custom_dir.py
test-packages/synthetic/specs/gdtest_user_guide_explicit.py
test-packages/synthetic/specs/gdtest_user_guide_hyphen.py
test-packages/synthetic/specs/gdtest_user_guide_sections.py
test-packages/synthetic/specs/gdtest_user_guide_subdirs.py
tests/__init__.py
tests/test_config.py
tests/test_contrast.py
tests/test_directives.py
tests/test_gdg_rendered.py
tests/test_great_docs.py
tests/test_harper.py
tests/test_integration.py
tests/test_link_checker.py
tests/test_lint.py
tests/test_post_render.py
tests/test_readme_images.py
tests/test_synthetic.py
tests/renderer/__init__.py
tests/renderer/test_classes.py
tests/renderer/test_format.py
tests/renderer/test_functions.py
tests/renderer/test_mixin_call.py
tests/renderer/test_typing.py
user_guide/00-introduction.qmd
user_guide/01-installation.qmd
user_guide/02-quickstart.qmd
user_guide/03-configuration.qmd
user_guide/04-api-documentation.qmd
user_guide/05-cli-documentation.qmd
user_guide/06-user-guides.qmd
user_guide/07-custom-sections.qmd
user_guide/08-blog.qmd
user_guide/09-theming.qmd
user_guide/10-cross-referencing.qmd
user_guide/11-building.qmd
user_guide/12-deployment.qmd
user_guide/13-link-checker.qmd
user_guide/14-proofreading.qmd
user_guide/15-changelog.qmd
user_guide/16-community-files.qmd
user_guide/17-diagrams.qmd
user_guide/18-seo.qmd
user_guide/19-linting.qmd
user_guide/20-videos.qmd