一个简单的布局包
simplelayout-tang-agui的Python项目详细描述
3-simplelayout-package
简介
- 本次作业将大家完成的数据生成器进行打包，可供 pip 进行安装，发布到 PyPI。同时使用 Sphinx 构建文档，发布到 Read the Docs。
Sphinx is a powerful documentation generator that has many great features for writing technical documentation including:
- Generate web pages, printable PDFs, documents for e-readers (ePub), and more all from the same sources
- You can use reStructuredText or Markdown to write documentation
- An extensive system of cross-referencing code and documentation
- Syntax highlighted code samples
- A vibrant ecosystem of first and third-party extensions
Python 生态的文档大都以 Sphinx 进行发布，例如 Python 自身的官方文档、Pytorch 文档 等等。
Read the Docs 是一个可以自动化托管 Sphinx 文档的网站。
Read the Docs 有上手教程，参考。
要求
- 将个人完成的
2-simplelayout-generator项目中的simplelayout目录复制到本次作业的src目录下。 - 编写
setup.py- 参考官方文档，与 Packaging and distributing projects，正确配置
setuptools.setup()，确保能被pip正确安装，要求- package 名称设置为
simplelayout-github账号名 - 正确包含
src/simplelayout这个 package install_requires包含simplelayout的相关依赖- 正确配置
entry_points，使命令simplelayout对应simplelayout/__main__.py中的main()函数
- package 名称设置为
- 参考官方文档，与 Packaging and distributing projects，正确配置
- 参考 文档，正确打包
- 参考 文档，正确上传到 PyPI
- 根据参考教程，创建
docs目录，并创建Sphinx项目。- 在执行
sphinx-quickstart时输入相关信息 - Sphinx 默认使用 rst 格式（reStructuredText ）编写文档，可进行配置使用 Markdown 进行文档编写。
- 选做：参考 配置 autodoc、napoleon 插件，自动生成 simplelayout 中的 docstring API。
- 在本地生成正确的 Sphinx 文档
- 在执行
- 注册 Read the Docs，将个人仓库中的文档正确托管
- 将个人项目 PyPI 仓库的链接、read the docs 链接以评论的方式发在
Feedback上
注意
本次作业的在线测试分为以下部分：
- 测试能否正确执行
pip install .
分值：1 分
- 测试能否正确执行
pip install .
simplelayout -h
分值：1 分
以上测试通过后，会在 Feedback 中打印相关信息（包括 PyPI 链接，生成图片），但不会对 PyPI、Read the Docs 自动测试
- 项目
标签：
欢迎加入QQ群-->： 979659372
