PaddlePaddle / docs

Documentations for PaddlePaddle
https://www.paddlepaddle.org.cn/documentation/docs/zh/guides/index_cn.html
Apache License 2.0
237 stars 707 forks source link

【映射文档】update mapping docs, upgrade doc generate tools and add docs for generate tools #6804

Closed RedContritio closed 1 month ago

RedContritio commented 1 month ago
paddle-bot[bot] commented 1 month ago

感谢你贡献飞桨文档,文档预览构建中,Docs-New 跑完后即可预览,预览链接:http://preview-pr-6804.paddle-docs-preview.paddlepaddle.org.cn/documentation/docs/zh/api/index_cn.html 预览工具的更多说明,请参考:飞桨文档预览工具

RedContritio commented 1 month ago

现在看一共有四个工具:

  1. validata_unittest 检查单测是否规范
  2. validata_docs 检查文档与Matcher是否匹配
  3. validate_mapping_in_api_difference 检查文档自身是否规范
  4. apply_reference_from_api_difference 生成映射表首页

第1~2个工具的代码在paconvert中,直接将介绍挪到PaConvert的tools目录下的README中吧

第3~4个工具在docs/guides/model_convert/convert_from_pytorch,在该目录下新建tools目录吧,然后将所有工具移动到tools目录下,该介绍文档命名为tools/README

由于工具2需要使用工具3生成的文件,但工具3在docs中,因此在提到工具3时注意加上超链接引用过去

另外,auto_build_docs.py是什么工具?这个工具后续有没有推广价值,有的话也需要介绍下,都放paconvert/tools/README里吧

  1. paconvert 对应工具介绍已经移动到对应仓库
  2. 已经新建 tools 目录
  3. 已经添加了超链接引用
  4. auto_build_docs 是在文档缺失严重的时候,用来快速补充文档的,其作用是基于 api_mapping.json 的内容给出文档框架(效果和复制一份已有文档进行修改类似,只是省去了删除不需要内容的操作);此前存量的映射文档缺失已经基本清空,后续将不再使用。
zhwesky2010 commented 1 month ago

@RedContritio PaConvert那边已修改,这边联动修改吧