CodeForAfrica / CodeForAfrica/HealthTools.API

Publish documentation using Sphinx

未关闭
#39 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看
enhancement help wanted
主要语言
Python
星标
19
派生
20
PR 合并指标
30 天内没有已合并 PR

描述

While looking at #33 that seemed like the simplest approach / lowest hanging fruit and exciting to publish docs with, the better documentation publishing for Python is Sphinx.

Let's therefore use Sphinx instead following this - http://docs.python-guide.org/en/latest/writing/documentation/

贡献指南

打开贡献指南

调研方向

该 issue 提到了 Sphinx,并链接到 Python 文档指南,但没有提供 repository 文件、测试或文档入口。首先检查现有的文档结构和链接的指南;当项目文档已使用 Sphinx 完成配置并发布时,即视为完成。

由索引模型根据 Issue 内容生成。

评估

技术栈
python
领域
documentation
Issue 类型
文档
难度
4/5
预计耗时
3-5 天
活跃度
停滞
描述清晰度
需要澄清
新手友好度
25/100

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。