Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: added mathjax for rendering tex format as imgmath needs latex engine to run #316

Merged
merged 4 commits into from
Jul 20, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 1 addition & 2 deletions .github/workflows/ci_docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -39,8 +39,7 @@ jobs:
- name: Install Texlive & tree
run: |
sudo apt-get update --fix-missing
# install Texlive, see https://linuxconfig.org/how-to-install-latex-on-ubuntu-20-04-focal-fossa-linux
sudo apt-get install -y cmake tree pandoc texlive-latex-extra dvipng texlive-pictures
sudo apt-get install -y cmake tree pandoc

- name: Install dependencies
run: |
Expand Down
2 changes: 0 additions & 2 deletions .github/workflows/docs-deploy.yml
Original file line number Diff line number Diff line change
Expand Up @@ -55,8 +55,6 @@ jobs:
mkdir -p ${PATH_DATASETS}
sudo apt-get update --fix-missing
sudo apt-get install -y cmake pandoc
# install Texlive, see https://linuxconfig.org/how-to-install-latex-on-ubuntu-20-04-focal-fossa-linux
sudo apt-get install -y texlive-latex-extra dvipng texlive-pictures
pip install -q -r _requirements/docs.txt -f ${TORCH_URL}
pip list
shell: bash
Expand Down
7 changes: 6 additions & 1 deletion _docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -63,12 +63,12 @@
"sphinx.ext.intersphinx",
"sphinx.ext.todo",
"sphinx.ext.napoleon",
"sphinx.ext.imgmath",
"sphinx.ext.githubpages",
"nbsphinx",
"myst_parser",
"sphinx_paramlinks",
"pt_lightning_sphinx_theme.extensions.lightning",
"sphinx.ext.mathjax",
]

# Add any paths that contain templates here, relative to this directory.
Expand Down Expand Up @@ -205,6 +205,11 @@
),
]

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

# -- Options for Epub output -------------------------------------------------

# Bibliographic Dublin Core info.
Expand Down
Loading