[How TO]-如何编写Linux kernel documentation

本文档详细介绍了如何使用Sphinx配置环境、生成HTML和PDF文档,并针对常见的编译错误提供了解决方案,如安装xelatex和six模块。通过这个指南,读者将能够顺利构建和编译技术文档。

摘要生成于 C知道 ,由 DeepSeek-R1 满血版支持, 前往体验 >

更多课程点击此处


快速链接:
.
👉👉👉 [专栏目录]-环境搭建安装问题笔记目录 👈👈👈

1、配置环境

$ virtualenv sphinx_1.7.9
$ . sphinx_1.7.9/bin/activate
$ pip install -r Documentation/sphinx/requirements.txt

2、生成文档

$ virtualenv sphinx_1.7.9
$ . sphinx_1.7.9/bin/activate
$ make htmldocs //生成html文档
$ make pdfdocs //生成pdf文档

3、编译报错解决

Documentation/Makefile:94: The ‘xelatex’ command was not found. Make sure you have it installed and in PATH to produce PDF output
sudo apt-get install texlive-xetex, 参考这里

Could not import extension kfigure (exception: No module named ‘six’)
sudo pip3 install six, 参考这里


(参考:How to write kernel documentation)

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

Arm精选

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付:¥1
获取中
扫码支付

您的余额不足,请更换扫码支付或充值

打赏作者

实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值