docs: standardize .. code-block directive usage (#33122)

and fix typos
This commit is contained in:
Mason Daugherty
2025-09-25 16:49:56 -04:00
committed by GitHub
parent c3fed20940
commit 5bea28393d
24 changed files with 102 additions and 118 deletions

View File

@@ -50,7 +50,7 @@ class GalleryGridDirective(SphinxDirective):
individual cards + ["image", "header", "content", "title"].
Danger:
This directive can only be used in the context of a Myst documentation page as
This directive can only be used in the context of a MyST documentation page as
the templates use Markdown flavored formatting.
"""

View File

@@ -126,7 +126,7 @@ extensions = [
"sphinx.ext.viewcode",
"sphinxcontrib.autodoc_pydantic",
"IPython.sphinxext.ipython_console_highlighting",
"myst_parser",
"myst_parser", # For generated index.md and reference.md
"_extensions.gallery_directive",
"sphinx_design",
"sphinx_copybutton",
@@ -259,20 +259,8 @@ html_static_path = ["_static"]
html_css_files = ["css/custom.css"]
html_use_index = False
myst_enable_extensions = [
"colon_fence", # ::: directive blocks (existing prior to LangGraph support)
# LangGraph compatibility extensions added for consolidation
# TODO: check for presence of each in LangGraph and only enable if needed
# "deflist", # Definition lists
# "tasklist", # - [ ] checkboxes (common in examples)
# "attrs_inline", # {.class} inline attributes (MkDocs style)
# "attrs_block", # Block-level attributes
# "substitution", # Variable substitution
# "linkify", # Auto-link URLs in text
# Math extensions (uncomment if LangGraph uses mathematical notation)
# "dollarmath", # $ math $ inline math
# "amsmath", # Advanced math environments
]
# Only used on the generated index.md and reference.md files
myst_enable_extensions = ["colon_fence"]
# generate autosummary even if no references
autosummary_generate = True

View File

@@ -6,7 +6,7 @@ sphinx-copybutton
sphinxcontrib-googleanalytics
pydata-sphinx-theme>=0.15
myst-parser>=3
toml>=0.10.2
myst-nb>=1.1.1
toml>=0.10.2
pyyaml
beautifulsoup4