跳转到主要内容

Jupyter Book的LaTeX特定功能

项目描述

sphinx-jupyterbook-latex

Documentation Status

支持Jupyter Book的LaTeX基础设施的Sphinx扩展。

此存储库是一个 开发 项目,旨在提高Jupyter Book中的LaTeX支持。

入门

要开始使用 sphinx-jupyterbook-latex,首先通过 pip 安装它

pip install sphinx-jupyterbook-latex

然后,将 sphinx_jupyterbook_latex 添加到您的扩展中,在Sphinx conf.py

extensions = ["sphinx_jupyterbook_latex"]

# autoload the sphinx.ext.imgconverter extension, optional (default is True)
# jblatex_load_imgconverter = True
# turn root level toctree captions into top-level `part` headings, optional (default is to auto-infer)
#  jblatex_captions_to_parts = True

OR 在jupyterbook config.yml

sphinx:
    extra_extensions:
    - sphinx_jupyterbook_latex
    # config:
    #   jblatex_load_imgconverter: true
    #   jblatex_captions_to_parts: true

扩展详细信息

此扩展不提供实际的Sphinx LaTeX主题,而是实例化多个转换(仅适用于LaTeX构建器),这些转换将AST转换为所需的格式

  1. 覆盖一些配置
  • latex_engine -> xelatex
  • latex_theme -> jupyterBook
  • 将必要的LaTeX命令附加到序言中
  1. 当指定了LaTeX构建器时
  • 设置sphinx.ext.imgconverter(如果jblatex_load_imgconverter
  • 替换根文档中的子标题
  • 从根级到目录树标题创建标题(如果jblatex_captions_to_parts
  • 将参考文献移至文档底部

问题

需要解决的问题列表

https://github.com/executablebooks/meta/issues/169

开发者说明

一个包含许多不同项目配置的仓库,用于测试和开发,其中包含实现想法和说明

项目详情


下载文件

下载适用于您的平台的文件。如果您不确定选择哪个,请了解更多关于安装包的信息。

源分布

sphinx_jupyterbook_latex-1.0.0.tar.gz (11.9 kB 查看散列)

上传时间

构建分布

sphinx_jupyterbook_latex-1.0.0-py3-none-any.whl (13.3 kB 查看散列)

上传时间 Python 3

支持者: