Skip to content

Commit

Permalink
docs: fix rendering of math equations
Browse files Browse the repository at this point in the history
  • Loading branch information
wujingyue authored and Borda committed Mar 21, 2024
1 parent 3492f14 commit 77c4a8e
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 3 deletions.
3 changes: 1 addition & 2 deletions .github/workflows/docs-build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -14,12 +14,11 @@ defaults:
shell: bash

jobs:
build-docs:
docs-make:
uses: Lightning-AI/utilities/.github/workflows/check-docs.yml@v0.11.0
with:
python-version: "3.10"
requirements-file: "requirements/docs.txt"
install-tex: true

deploy-docs:
needs: docs-make
Expand Down
9 changes: 8 additions & 1 deletion docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,7 @@ def _transform_changelog(path_in: str, path_out: str) -> None:
"sphinx.ext.linkcode",
"sphinx.ext.autosummary",
"sphinx.ext.napoleon",
"sphinx.ext.imgmath",
'sphinx.ext.mathjax',
"myst_parser",
"nbsphinx",
"sphinx_autodoc_typehints",
Expand Down Expand Up @@ -209,6 +209,13 @@ def _transform_changelog(path_in: str, path_out: str) -> None:
(master_doc, project + ".tex", project + " Documentation", author, "manual"),
]

# MathJax configuration
mathjax3_config = {
'tex': {
'packages': {'[+]': ['ams', 'newcommand', 'configMacros']}
},
}

# -- Options for manual page output ------------------------------------------

# One entry per manual page. List of tuples
Expand Down

0 comments on commit 77c4a8e

Please sign in to comment.