Documentation building package used at EVAS Intelligence
Project description
这个项目根据esp-docs更改而来,将依赖的pip包更新到了最新版本 支持Sphinx7.2.6,原来evas-docs只支持Sphinx4.5.0 主题由sphinx-idf-theme更换成了原版的sphinx-rtd-theme
参考项目链接: evas-docs: https://github.com/espressif/esp-docs sphinx-idf-theme: https://github.com/espressif/sphinx_idf_theme
环境准备 Windows和Linux都可以
Windows下生成pdf需要安装Latex和Perl环境,Latex建议Miktex,Miktex需要设置国内宏包源,并且设置根据需要自动下载宏包 Miktex: https://miktex.org/download Perl: https://strawberryperl.com/
启用sphinxcontrib.wavedrom扩展 在Windows环境下需要下载GTK+ for Windows Runtime Environment 64-bit https://github.com/tschoonj/GTK-for-Windows-Runtime-Environment-Installer/releases
记得一定要加上--no-dependencies参数不安装依赖,否则会额外安装一个xcffib包,导致生成报libxcb找不到的错误 pip install --no-dependencies -r requirements.txt
如果xcffib不小心被安装,可以使用如下命令卸载 pip uninstall xcffib -y
构建evas-docs pip包
pip install build twine python -m build twine upload dist/*
使用方法
切换到docs文件夹 cd docs
生成html build-docs build 或 build-docs -l en
生成pdf build-docs -bs latex -l en
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for evas_docs-0.0.4-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 477d5de30450a4761990c6bf4aba403b3eafff2471b8c35faa5c6de94e55c22d |
|
MD5 | 45a55c83ed0c03df04e0c3add0db4bd4 |
|
BLAKE2b-256 | e776bacce06ea7fe1c2c0744d07362c0677a03dd79e035ed7e0e3cc279458fbd |