本手册由Sphinx生成,并使用Executable Book Project 主题,可以解析markdown与Latex公式。 Sphinx官网、 Sphinx中文手册。
本手册参考项目为 phonopy手册。
以下为与本项目相关的知识的最小合集
pip install sphinx myst-parser sphinx-book-theme sphinxcontrib-mermaid
# or
pip install -r requirements.txt
#option
# pip install sphinx-math-dollar
# pip install -U sphinx-mathjax-offline
make html
make latex
修改latex 相关参数
需要修改conf.py
参见