From 77c4a8e4787b744e72b579bc00773ba3c8bb78b9 Mon Sep 17 00:00:00 2001 From: Jingyue Wu Date: Mon, 18 Mar 2024 18:23:27 +0100 Subject: [PATCH 1/3] docs: fix rendering of math equations --- .github/workflows/docs-build.yml | 3 +-- docs/source/conf.py | 9 ++++++++- 2 files changed, 9 insertions(+), 3 deletions(-) diff --git a/.github/workflows/docs-build.yml b/.github/workflows/docs-build.yml index d17ae79eef..3db7a14942 100644 --- a/.github/workflows/docs-build.yml +++ b/.github/workflows/docs-build.yml @@ -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 diff --git a/docs/source/conf.py b/docs/source/conf.py index 052fa2437c..5aa5a3567e 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -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", @@ -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 From a2d304438fed2d72c3428579e6ae199a1dfb6de7 Mon Sep 17 00:00:00 2001 From: "pre-commit-ci[bot]" <66853113+pre-commit-ci[bot]@users.noreply.github.com> Date: Thu, 21 Mar 2024 18:48:20 +0000 Subject: [PATCH 2/3] [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci --- docs/source/conf.py | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/docs/source/conf.py b/docs/source/conf.py index 5aa5a3567e..598dc42053 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -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.mathjax', + "sphinx.ext.mathjax", "myst_parser", "nbsphinx", "sphinx_autodoc_typehints", @@ -211,9 +211,7 @@ def _transform_changelog(path_in: str, path_out: str) -> None: # MathJax configuration mathjax3_config = { - 'tex': { - 'packages': {'[+]': ['ams', 'newcommand', 'configMacros']} - }, + "tex": {"packages": {"[+]": ["ams", "newcommand", "configMacros"]}}, } # -- Options for manual page output ------------------------------------------ From dcb0109eeea1dd2dbff2511f846788a34a7400fe Mon Sep 17 00:00:00 2001 From: Jirka Date: Fri, 22 Mar 2024 10:28:39 +0100 Subject: [PATCH 3/3] tex --- .github/workflows/docs-build.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/.github/workflows/docs-build.yml b/.github/workflows/docs-build.yml index 3db7a14942..f3ec8bbc59 100644 --- a/.github/workflows/docs-build.yml +++ b/.github/workflows/docs-build.yml @@ -19,6 +19,7 @@ jobs: with: python-version: "3.10" requirements-file: "requirements/docs.txt" + install-tex: true deploy-docs: needs: docs-make