🌲[Pydumpling] 为Pydumpling增加接口注释

开源松
,
1

项目地址： Add doc string for pydumpling · Issue #9 · cocolato/pydumpling (github.com)
难度：简单

为Pydumpling的四个主要Api增加接口文档/docstring，可以考虑使用sphinx进行接口文档的生成。

2

我花了点时间看了一下Flask的文档，然后照着它写了个简单的文档，下面是网址：
http://47.94.8.104/ .
(目前只写了首页index和installtion页面，访问installation的话，需要将url地址改成大写的installation访问，不知道啥问题，本地访问没问题，部署到nginx后，就出现404了)

如果觉得可以的话，我可以认领。

1 个赞
3
4

感谢，不过我现在好像没办法分配任务，直接去创建PR即可

5

关于文档这方面，我看到Flask的仓库是每个branch都有docs的，而我看一篇文章, 它是直接创建一个docs分支来管理相关文档的，这两种方式我应该选择哪种？

6

我个人倾向第一种，文档和功能代码放在一起即可

7
8

这个有卡片的链接是怎么弄的

9

直接发链接就可以（在单独的一行），支持的站点会被渲染成卡片。

1 个赞
10

给 @jennier0107 颁发了文档奠基人徽章 :tada: :tada: