这是一个包含sphinx生成和设置的项目模板。文档生成使用的是pyquickhelper。
project_name的Python项目详细描述
链接：
简介
这个项目是任何新项目的框架。它包含：
- 源文件夹：src
- 单元测试文件夹：_unittests，转到该文件夹并运行run_unittests.py
- 文档文件夹：_doc，它将包含文档
- 生成和安装模块的文件setup.py。
所有这些步骤都是在windows上测试的。稍后将添加Linux支持。 要创建自己的项目，需要重命名^{tt1}中的文件夹project_name。$ 你的真实模块名。您还需要将project_name替换为找到它的位置：
- project_var_name = 'project_name'在setup.py、make_help.py和_doc/sphinxdoc/source/conf.py
- from src.project_name.subproject.myexample import myclass在_unittests/ut_example/test_example.py
- _doc/sphinxdoc/source/index.rst 中的许多地方
- README.rst 中的许多位置
自动化
- Generating the setup with pyquickhelper
- Generating the documention with pyquickhelper
- Installation
- Unit tests with pyquickhelper
添加新模块或子包
应该在src/project_name中添加任何新模块或子包。每个子文件夹都应该 包含文件__init__.py。如果新文件需要一个现有的子模块，则需要 添加如下内容：
import os,sys from ..subproject.myexample import myclass
您应该尽可能使用相对导入。 若要在比上一个模块更深的级别添加模块，请 应该在每个__init__.py中添加相对导入。
版本
- 0.2-2016/？？/？？
- change:更新pyquickhelper>；=1.4
- 0.1-2016/03/26
- new:第一个版本
- fix:安装程序不再需要文件README.rst
- add:检查文件的单元测试README.rst遵循docutils 0.8的语法（对于pipy）
- add:添加单元测试以脱机运行所有笔记本
欢迎加入QQ群-->： 979659372
