Skip to content

Commit

Permalink
update config, add extension sphinxcontrib.video, exclude .pytest_cac…
Browse files Browse the repository at this point in the history
…he, update heading depth to 6, add myst_substitutions
  • Loading branch information
CopyDemon committed Sep 12, 2024
1 parent fadbb0c commit 7a2849f
Showing 1 changed file with 12 additions and 5 deletions.
17 changes: 12 additions & 5 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -15,34 +15,41 @@
"sphinx.ext.autosummary",
"sphinx.ext.napoleon",
"sphinx.ext.viewcode",
"sphinxcontrib.video",
]
templates_path = ["_templates"]
exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
exclude_patterns = ["_build", "Thumbs.db", ".DS_Store", ".pytest_cache"]

# HTML
static_dir = "static"
html_theme = "sphinx_book_theme"
html_static_path = [static_dir]
html_logo = "static/logo.png"
html_theme_options = {
"logo": {"image_light": f"{static_dir}/logo.png", "image_dark": f"{static_dir}/logo.png"},
"logo": {
"image_light": f"{static_dir}/logo.png",
"image_dark": f"{static_dir}/logo.png",
},
"repository_provider": "github",
"repository_url": "https://github.com/IDAES/idaes-ui",
"use_repository_button": True,
"path_to_docs": "docs",
}

# MyST
myst_heading_anchors = 3
myst_heading_anchors = 6
myst_enable_extensions = [
"deflist", # definition lists
"attrs_inline", # inline attributes on images using MD syntax
"substitution", # for global substitutions; see myst_substitutions
"attrs_inline", # inline attributes on images using MD syntax
"substitution", # for global substitutions; see myst_substitutions
]
myst_substitutions = {
# Change these two lines to rename the Flowsheet Visualizer (!)
"vistitle": "Flowsheet Visualizer",
"visabbr": "FV",
"mov": "mov",
"mp4": "mp4",
"video-width": 800,
}

# Autodoc
Expand Down

0 comments on commit 7a2849f

Please sign in to comment.