用于 Python 包装的 Biolerplate
项目描述
串行狮身人面像
为什么？
快速原型制作需要样板代码
什么？
serial-sphinx提炼有关使用 sphinx 将文档上传到readthedocs.org的领域知识。关注博客以获取更多有用信息。
命令片段
rm -r docs
cd docs
sphinx-quickstart
从存储库复制配置文件。然后，在docs文件夹中
sphinx-apidoc -o source/ ../<package_name>
make html
确保遵循存储库中列出的适当文件结构。
使用配置的 webhook 将其推送给您的 repo，您就完成了。
适当的测试
请确保设置一些 CI/CD 管道。如果您要避免商业设置，那么这是一个问题。
对于代码质量，请确保使用pytest-cov. 查看提供的setup.cfg文件。
啄木鸟CI
开源 CI。但不像 Github-actions。检查.woodpecker.yml经过测试的标准工作流程。
代码覆盖率
代码覆盖率的通过目标应在setup.cfg键下编辑addopts
