pwr-Solaar/Solaar

Docs: Build developer docs from code

Open

#2,503 创建于 2024年5月27日

在 GitHub 查看
 (2 评论) (0 反应) (0 负责人)Python (383 fork)batch import
enhancementhelp wanted

仓库指标

Star
 (4,528 star)
PR 合并指标
 (平均合并 1天 15小时) (30 天内合并 5 个 PR)

描述

Some code pieces already contain docstrings, which should be automatically compiled to documentation and published with GitHub pages on a page Developer documentation.

The numpydoc format is the preferred style.

贡献者指南

研究方向
使用 numpydoc 格式从文档字符串自动生成文档并发布到 GitHub Pages。
技术栈
python
领域
documentation
议题类型
文档
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
2
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
半天
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
活跃
清晰度议题是否清楚说明期望改动、验收标准和下一步。
清晰
前置要求
PythonGit
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
75