Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc生成逻辑需要优化 #333

Closed
knightast opened this issue Nov 23, 2023 · 2 comments
Closed

doc生成逻辑需要优化 #333

knightast opened this issue Nov 23, 2023 · 2 comments
Assignees

Comments

@knightast
Copy link
Contributor

文档包括:静态文档(./docs),动态文档(procedure api文档)

需要:

  1. 文档能整体在 readthedocs 页面展示,https://tugraph-db.readthedocs.io/zh_CN/latest/
  2. 能够通过ci保证文档可编译

整体流程是通的,但有些问题:

  1. 手动执行 cpplint/doc_gen.sh 会删文件,不能重复执行,逻辑需要更新
  2. https://github.com/TuGraph-family/tugraph-db/blob/master/docs/zh-CN/source/conf.py 中有硬编码版本3.5.0,so的更新逻辑是啥?
@knightast knightast assigned knightast and lipanpan03 and unassigned knightast Nov 23, 2023
@lipanpan03
Copy link
Collaborator

#337 收到,已修改文档生成逻辑:

  1. 在删除文件之前先判断,文档生成在本地环境和read_the_docs环境中均能重复执行
  2. 将doc生成依赖文件夹改为doc_deps,删除硬编码3.5.0

@qishipengqsp
Copy link
Collaborator

Fixed

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants