[ATF]文档编译docutils

本文介绍了如何在ATF项目中利用Sphinx工具进行文档编译,包括makehelp命令的使用、缺失依赖的安装、以及不同文档目标的制作,如HTML文件的生成。重点展示了makehtml步骤和生成的HTML文档结构。
摘要由CSDN通过智能技术生成

在ATF根目录make help可以看到编译文档的选项

```c make help ... doc Build html based documentation using Sphinx tool ... ```

执行make doc如果报错缺少xx软件,需要先安装一下依赖

先安装编译文档所需要的依赖

 pip install -r docs/requirements.txt
 
 

也可以cd doc下直接make

cd doc
make help
 
Sphinx v4.3.2
Please use `make target' where target is one of
  html        to make standalone HTML files
  dirhtml     to make HTML files named index.html in directories
  singlehtml  to make a single large HTML file
  pickle      to make pickle files
  json        to make JSON files
  htmlhelp    to make HTML files and an HTML help project
  qthelp      to make HTML files and a qthelp project
  devhelp     to make HTML files and a Devhelp project
  epub        to make an epub
  latex       to make LaTeX files, you can set PAPER=a4 or PAPER=letter
  latexpdf    to make LaTeX and PDF files (default pdflatex)
  latexpdfja  to make LaTeX files and run them through platex/dvipdfmx
  text        to make text files
  man         to make manual pages
  texinfo     to make Texinfo files
  info        to make Texinfo files and run them through makeinfo
  gettext     to make PO message catalogs
  changes     to make an overview of all changed/added/deprecated items
  xml         to make Docutils-native XML files
  pseudoxml   to make pseudoxml-XML files for display purposes
  linkcheck   to check all external links for integrity
  doctest     to run all doctests embedded in the documentation (if enabled)
  coverage    to run coverage check of the documentation (if enabled)
  clean       to remove everything in the build directory

make html成功之后,会在docs\build\html下产生html文档,使用浏览器就可以阅读了。

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

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

余额充值