pybind / pybind/python_example
Building the docs
未关闭
还没有人认领这个 Issue。
- 主要语言
- Python
- 星标
- 530
- 派生
- 150
- 平均合并
- 8 天 2 小时
- 30 天内合并 PR
- 1
描述
Hi,
I can build the docs with Sphinx using make html but when I open the html files I can't see any of the function docstrings. I'm new to Sphinx so I might be missing something.
贡献指南
这个仓库没有索引到贡献指南
从这里开始
- 先读完整个 Issue，再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库，在一个分支上完成修改。
- 提交 Pull Request，并在描述里引用这个 Issue 编号。
调研方向
首先使用 make html 运行文档中说明的 Sphinx 构建，并结合 Sphinx 配置检查生成的 HTML。确定为什么未包含 Python 函数的 docstring；当生成的文档显示这些 docstring 时，即表示完成。
由索引模型根据 Issue 内容生成。
评估
- 技术栈
- python
- 领域
- documentation
- Issue 类型
- 缺陷
- 难度
- 3/5
- 预计耗时
- 1-2 天
- 活跃度
- 停滞
- 描述清晰度
- 需要澄清
- 新手友好度
- 35/100