Как добавить физический пакет LaTeX в Sphinx

#python #latex #python-sphinx

#python #Латекс #python-sphinx

Вопрос:

Я хочу представить квантовую формулу в Sphinx. Код LaTeX:

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

Похоже, требуется пакет ‘physics’ из LaTeX.
Как я могу добавить этот пакет в Sphinx?

Я попытался изменить conf.py изображение Сфинкса с добавлением двух строк. Но это не работает.

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

Вывод Sphinx:

Воспроизвести проблему:

Я только что внес очень примерные изменения в conf.py и индекс.первый

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

1. Можете ли вы сказать немного больше, чем просто «это не работает»? Что именно происходит?

2. Sphinx не может скомпилировать символ LaTeX ket. Я загружу картинку, чтобы показать, что я получил от sphinx.

3. Я загрузил весь код, который я изменил. Когда я запускал make html , я не получал никаких ошибок в терминале.

Ответ №1:

Решение

Добавьте следующую строку в conf.py:

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

Это гарантирует, что используется MathJax 3.

Подробнее

Если вы используете математику в своих первых документах и не указываете средство визуализации для вывода HTML в conf.py , используется MathJax.

Значение по умолчанию mathjax_path в Sphinx (версия 3.4.3) равно https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.7/latest.js?config=TeX-AMS-MML_HTMLorMML (MathJax 2).

С MathJax 2 я получил тот же плохой результат, что и вы. Я нашел рабочий URL по адресу https://www.mathjax.org/#gettingstarted .