如何在 Sphinx 中添加 LaTex 的物理包

Question

我想在 Sphinx 中展示一个量子公式。 乳胶代码：

\ket{\psi}=\frac{1}{\sqrt{2}}(\ket{00}+\ket{11})

看起来需要 LaTeX 的“物理”包。 如何在 Sphinx 中添加这个包？

我尝试通过添加两行来修改 Sphinx 的 conf.py。但它不起作用。

# -- Options for LaTeX output -------------------------------------------------
latex_engine = 'xelatex'
latex_elements = {'preamble':r'\usepackage{physics}'}

狮身人面像的输出：

重现问题：

我刚刚对 conf.py 和 index.rst 做了一些示例性的更改

conf.py：

# Configuration file for the Sphinx documentation builder.
#
# This file only contains a selection of the most common options. For a full
# list see the documentation:
# https://www.sphinx-doc.org/en/master/usage/configuration.html

# -- Path setup --------------------------------------------------------------

# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
#
# import os
# import sys
# sys.path.insert(0, os.path.abspath('.'))
import sphinx_rtd_theme


# -- Project information -----------------------------------------------------

project = 'aaa'
copyright = 'bbb'
author = 'ccc'

# The full version, including alpha/beta/rc tags
release = '2021'


# -- General configuration ---------------------------------------------------

# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = ['sphinx.ext.todo']

# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']

# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
# This pattern also affects html_static_path and html_extra_path.
exclude_patterns = []

# -- Options for LaTeX output -------------------------------------------------
latex_engine = 'xelatex'
latex_elements = {'preamble':r'\usepackage{physics}'}

# -- Options for TODO output -------------------------------------------------
todo_include_todos = True

# -- Options for HTML output -------------------------------------------------

# The theme to use for HTML and HTML Help pages.  See the documentation for
# a list of builtin themes.
#
html_theme = 'sphinx_rtd_theme'


# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]

index.rst:

.. toctree::
   :maxdepth: 2
   :caption: Contents:

Contents
=======================
:math:`\ket{\psi}=\frac{1}{\sqrt{2}}(\ket{00}+\ket{11})`

然后，我运行make html 并得到以下页面： index.html

Answer 1

解决方案

在 conf.py 中添加以下行：

mathjax_path = "https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js"

这可确保使用 MathJax 3。

更多详情

如果您在 RST 文档中使用数学并且未在 conf.py 中为 HTML 输出指定渲染器，则使用 MathJax。

Sphinx（3.4.3 版）中mathjax_path 的默认值为https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.7/latest.js?config=TeX-AMS-MML_HTMLorMML（MathJax 2）。

使用 MathJax 2，我得到了和你一样糟糕的输出。我在 https://www.mathjax.org/#gettingstarted 找到了工作 URL。