zephyr文档生成
本文说明在ubuntu 18.04下如何生成zephyr文档
由于一些原因,我们访问通过网络访问zephyr的文档速度比较慢。好在zephyr的文档是和zephyr的source code一起发布的,因此可以编译出zephyr文档,在本地访问。
安装依赖 链接到标题
文档的生成依赖于zephyr的编译环境,按照https://docs.zephyrproject.org/latest/getting_started/index.html#getting-started 安装zephyr的编译环境,这里不再详细列出。在能编译zephyr的情况下要生成zephyr文档还需要附加安装下面的工具:
sudo apt-get install --no-install-recommends doxygen librsvg2-bin \
texlive-latex-base texlive-latex-extra latexmk texlive-fonts-recommended
编译文档 链接到标题
使用下面命令可以产生zephyr文档
cd ~/zephyr
source zephyr-env.sh
mkdir -p doc/_build && cd doc/_build
cmake -GNinja ..
#产生html格式的文档
ninja htmldocs
#产生pdf文档
ninja pdfdocs
编译的时间会比较长,对于html文档可以使用下面命令加速编译,但文档中不会包含Kconfig选项的说明
make htmldocs-fast
其它问题 链接到标题
如果更新zephyr后编译html文档发现下面错误
Could not import extension sphinx_tabs.tabs
可能是pip包的依赖版本比较低,使用下面方法更新zephyr依赖的pip包
pip3 install --user -r ~/zephyrproject/zephyr/scripts/requirements.txt