这是一个包含设置和sphinx生成的项目模板。文档生成使用pyquickhelper。
项目描述
链接
简介
此项目是任何新项目的骨架。它包含
一个源文件夹： src
一个单元测试文件夹： _unittests，进入此文件夹并运行 run_unittests.py
一个 _doc 文件夹： _doc，它将包含文档
一个 setup.py 文件用于构建和安装模块
所有这些步骤仅在Windows上进行了测试。稍后将添加对Linux的支持。要创建自己的项目，您需要将 src 中的文件夹 项目名称 重命名为您的真实模块名称。您还需要将 项目名称 替换为其所在之处
project_var_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 中
项目也托管在此处 [链接]，您可以找到基于此模板生成的文档的链接。
自动化
添加新的模块或子包
任何新的模块或子包都应该添加到 src/project_name 中。每个子文件夹都应该包含一个文件 __init__.py。如果新文件需要现有的子模块，您需要添加以下内容：
import os,sys from ..subproject.myexample import myclass
您应尽可能使用相对导入。要添加比上一个更深的模块，您应该在沿途的每个 __init__.py 中添加相对导入。
版本
- 0.2 - 2016/??/??
更改：更新为 pyquickhelper >= 1.4
- 0.1 - 2016/03/26
新：第一个版本
修复：设置不再需要 README.rst 文件
添加：添加单元测试以检查 README.rst 文件是否符合 docutils 0.8 语法（针对 pipy）
添加：添加一个单元测试以运行所有离线笔记本
