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.

Sign up for GitHub

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

Jump to bottom

不要构建依赖库的文档 #3

Open
zjp-CN opened this issue Nov 2, 2024 · 0 comments
Open

不要构建依赖库的文档 #3

zjp-CN opened this issue Nov 2, 2024 · 0 comments

Comments

@zjp-CN
Copy link
Member

zjp-CN commented Nov 2, 2024 •
edited
Loading

一般构建依赖库的文档，在开发时是最有用的。

但 os-checker 作为一个集成工具，显示太多的依赖库文档是不必要的？因为 os-checker 部署文档的主要使用者是库的使用者而不是库的开发者。（开发者可以使用本地构建来浏览依赖项的 APIs）

截图_20241102231112

而且，当前仅在 os-checker 和 test-suite 上构建含依赖的文档，就需要 41.5 MB 存储大小的静态网页。（Github Pages 有 1 GB 的部署上限。）

更新：当应用 --no-deps 时，文档大小为 4.17 MB，缩小了 10 倍。并且侧边栏看起来更清爽：
截图_20241102232555
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@zjp-CN