之前开源的模拟登录工具包开源文档上线啦~

原文链接

嘿嘿，之前开源的模拟登录工具包开源文档上线啦~​mp.weixin.qq.com

导语

各位小伙伴还记得之前开源的模拟登录工具包嘛，就是这个：

前排造轮子|分享一个最近自己开源的小项目

前段时间上传到pypi之后：

来个小教程吧 | 发布自己的python库到pypi

就一直想着再给它搞个开源项目文档，让它变得更“正规”一些。今天整了一上午，终于实现了这个小目标，过来再简单推销一下这个项目以及记录下制作文档的过程。

DecryptLogin简介

DecryptLogin是我自己开源的一个用于实现网站模拟登录的python第三方工具包。目前支持以下网站的模拟登录：

项目地址(欢迎stars呀)：

https://github.com/CharlesPikachu/DecryptLogin

项目的开源文档地址：

DecryptLogin中文文档 - DecryptLogin 0.1.0 文档

https://httpsgithubcomcharlespikachudecryptlogin.readthedocs.io/zh/latest/ (In Chinese)
https://httpsgithubcomcharlespikachudecryptlogin.readthedocs.io/en/latest/ (In English)

简单截个图(其实还有些功能没写，以后慢慢完善吧)

项目中也包含了之前发的关于该库的使用案例的所有源代码，例如：

模拟登录系列 | 来写个网易云个人歌单下载器？

模拟登录系列 | 下载B站指定UP主的所有视频

等等(后面还会添加更多有趣的案例~)。

简单聊聊文档的制作过程

首先当然是找资料啦，第一反应是在Github上搜索一下开源文档的制作教程，结果找到了这个：

http://www.wbh-doc.com.s3.amazonaws.com/Python-OpenSource-Project-Developer-Guide/index.html

上面介绍了三种部署开源文档的方式：

(1) 使用PyPI Host
(2) 使用ReadTheDocs
(3) 使用AWS S3
因为ReadTheDocs可以自动关联Github账户实现网站自动更新，
而且完全免费，于是我选择了第二种方案。

以及创建开源文档网站可以使用的工具：

sphinx是Python社区用于自动生成文档网站的工具。
可以用来生成纯文档, 也可以自动从Python代码中提取文档。

确定了工具之后，就去网上找了个模板(用的港中文和商汤联合开源的mmdetection里的文档模板)：

https://github.com/open-mmlab/mmdetection/tree/master/docs

顺便去官网简单地浏览了一下sphinx的使用教程

http://www.sphinx-doc.org/en/stable/

然后就是照着教程把下载的模板改成我自己的开源文档网站。但是制作过程中遇到了一个问题，我想把文档搞成中英文双版本的，一时间在官方给的说明里没找到对应的教程，于是去Google搜索了一下，发现了这个网站：

https://readthedocs-demo-zh.readthedocs.io/zh_CN/latest/index.html

里面介绍了一个解决方案(大概就是项目导入两次然后设置一下翻译版本就OK了，当然如果需要两种以上的语言，操作就比这麻烦些了)，试了下，发现成功了：

大概是运气比较好，没遇到什么大坑，就这么直接部署成功了:

就是这样，同样需要部署文档的小伙伴可以参考一下上面提到的几个文章链接，感觉还是有帮助的。

总之，欢迎感兴趣的小伙伴关注一下这个项目呀~

https://github.com/CharlesPikachu/DecryptLogin

后面会不断完善这个库的功能以及增加更多有趣的小例子哒~