Documentation building package used at EVAS Intelligence
Project description
这个项目根据evas-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/
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
单独安装evas-docs,并将本项目src/evas-docs文件夹覆盖python安装目录下的Lib/site-packages/evas-docs pip install --no-dependencies evas-docs
如果xcffib不小心被安装,可以使用如下命令卸载 pip uninstall xcffib -y
使用方法
切换到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.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | edc5d14e6cca420e4b30d7d47cd503f3bc474e82f0dbaf074a742f96a71c3c39 |
|
MD5 | 8af63a7d2640c9a8f8a327457f71010b |
|
BLAKE2b-256 | 7afd306eb803908a74ae688239b0c7885e5fd8292d5127143045ec0ec34e3a0d |