开发规范&管理
文章平均质量分 91
代码、流程等相关规范
SkylerHu
我本微末凡尘,也可心向天空
展开
-
python使用MkDocs自动生成文档
python代码注释风格有很多,比较主流的有reStructuredText风格numpy风格Google风格。Pydocspython环境自带,支持MarkDown,但功能比较简单;Sphinx非常流行,默认支持reStructuredText风格注释,若要支持MarkDown需要扩展插件支持;MkDocs优势是能够很好的支持MarkDown格式来组织文档,支持Google风格注释;对于熟悉MarkDown语法的人来说,推荐使用MkDocs。原创 2024-06-01 16:33:50 · 628 阅读 · 0 评论 -
Github Actions/workflow的使用
Github提供了免费的Actions执行workflows工作流,在CI/CD场景下可用于跑测试用例、构建、打包、部署/发版等操作。1个project可以配置多个workflow,每个workflow使用一个yaml文件配置;单个workflow可以配置多个jobs;单个job可以配置多个steps;step中定义要执行的环境和命令。原创 2024-05-27 23:30:28 · 611 阅读 · 0 评论 -
如何生成Github Badge徽章图标
在开源项目的README中,经常会见到一些徽章(Badge)小图标,README中这些小图标,每个徽章都对应的一个URL。需要借助网站 shields 、 coveralls 、GitHub workflows工作流。原创 2024-05-21 23:36:03 · 823 阅读 · 0 评论