这个项目根据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
1 maintainer
Metadata
1 maintainer
Release files for evas-docs 0.0.4
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| evas-docs-0.0.4.tar.gz | 15.8 MB | Without provenance | Details for evas-docs-0.0.4.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| evas_docs-0.0.4-py3-none-any.whl | Python 3 | none | any | Details for evas_docs-0.0.4-py3-none-any.whl |
Total release size: 31.6 MB
Release files / evas-docs-0.0.4.tar.gz
| Download URL | evas-docs-0.0.4.tar.gz |
|---|---|
| Size | 15.8 MB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
ee4b70d228ecc6ed0e508d01a0f0c3df35bf6688a18dc682d19a22effcd4bc40
|
|
BLAKE2b-256 checksum How to use checksums |
720068b7c4b3a514ccba762350bee416a172d2466db2d6ccb07e59e5cc0cbc3a
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/5.0.0 CPython/3.10.11
|
Release files / evas_docs-0.0.4-py3-none-any.whl
| Download URL | evas_docs-0.0.4-py3-none-any.whl |
|---|---|
| Size | 15.8 MB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
477d5de30450a4761990c6bf4aba403b3eafff2471b8c35faa5c6de94e55c22d
|
|
BLAKE2b-256 checksum How to use checksums |
e776bacce06ea7fe1c2c0744d07362c0677a03dd79e035ed7e0e3cc279458fbd
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/5.0.0 CPython/3.10.11
|
Security for evas-docs 0.0.4
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
