tl.pkg

软件截图:
tl.pkg
软件详细信息:
版本: 0.1
上传日期: 15 Apr 15
开发: Thomas Lotze
许可: 免费
人气: 29

Rating: nan/5 (Total Votes: 0)

tl.pkg是一个命名空间的Python包与狮身人面像文档模板。
这个包生成的Python包的基本的文件和目录布局与狮身人面像文档和开发扩建。它由两部分组成:
- 一个paste.script模板创建样板的Python包,住在命名空间中的一个水平,
- 用于配置狮身人面像,以及必要的软件包的依赖以及一些主题化的Python模块。
包装工程与Python 2.6和2.7。
用法
为了使贴纸模板可用,安装tl.pkg那里贴纸可以找到它。然后运行贴纸:
 贴纸创建--template TL-PKG
这将生成样板的鸡蛋分发,完成与zc.buildout配置中,狮身人面像包文档的骨架,并初始化一个Mercurial库。该扩建的配置是针对发展,所以它会安装一个的TestRunner在斌/测试和斌/ DOC文档,一个建设者。
一些变量将被提示,其中一行的描述和一些关键字的包。
个性化
三个变量贴纸会要求您提供用于个性化的方案框架也将产生。这些变量也可以有一个名为文件$ HOME / .TL-pkg.cfg读取的,如果它存在默认值。文件需要遵循ini文件的语法所理解Python的ConfigParser和含有一个部分(具有一个任意名称迄今),它定义任何下列变量:
笔者:您的全名。这会出现在包元数据和文档,以及在产生任何Python文件的版权声明。
作者-邮件:您的E-mail地址。这似乎无论是在包的元数据和文档。
到位桶名称:您的用户到位桶的名字。这被用来构建属于该项目的各种网址。目前,假设是,该项目托管在,并在包元数据和文档点的任何URL到合适的项目到位桶的页面。
包装内容
这是为了解释所生成的文件和目录的目的,连同建议哪些文件进行编辑时。许多文件将不再需要在所有进行编辑。
Python发行
setup.py:包定义和元数据。更新此文件中至少每当包的版本号,依赖,进入点改变。
:源代码包树。不要修改该命名空间包的__init__.py文件,以免其他包在同一个命名空间无法导入。
Mercurial库
.hg:已创建包时,Mercurial库已被初始化。生成的文件还没有被提交。
.hg / hgrc:库配置指向包在一些水银托管将来的URL,如果有的话。它还设置你的汞的用户名。
.hgignore:文件和目录由水银被忽略。这包括本地配置和东西预计将扩建,建立文档或程序包的版本生成的。它不包括Python中生成的文件(如:*。pyc文件),分发(* .egg-INFO),或其他更普遍的工具,如编辑器,这是不特定于这个项目。这样的模式应该是默认的Mercurial忽略列表。
开发扩建
bootstrap.py:创建的bin /扩建脚本。用同样的Python解释器,扩建应使用运行此。无需过编辑这个文件。
buildout.cfg:创建一个测试运行,并为包一个文档生成器的一个工作扩建配置。包本身被包括作为一个发展鸡蛋和附加件被配置为使用任何其他的包仅被钉扎的版本。编辑这个配置包的官方发展扩建,但把当地的定制的local.cfg。版本pinnings进去版本/ versions.cfg,而该文件的版本部分应只撤消声明培养鸡蛋同一文件的扩建部分包pinnings。
local.cfg:在扩建的配置是不感兴趣的其他开发本地的定制。这是由水银忽略。如果更改了此文件,运行斌/扩建-c local.cfg从那时起。虽然这听起来很麻烦,首先,保持非本地配置在buildout.cfg和版本控制下为用例如连续集成服务器上测试该包重要。
版本/ versions.cfg:
 版本为牵制所用的扩建任何包是不是Zope的工具包的一部分。 tl.pkg的这是需要建立文档的版本被固定到创建的包文件的版本相同。当后来升级tl.pkg,这个版本寄托的需求将随着该版本之间的包模板中被修改的文件更新。编辑这个文件,以针通过你的包或扩建所需的任何鸡蛋的版本。
版本/ ZTK-版本,X.Y.Z.cfg:
  Zope的工具包中固定的发布,包括在我们的版本pinnings。保持这一个本地副本允许建设没有网络接入的扩建。不要修改此文件。
总包文档
还有一些文本文件,在包的顶级目录被发现含有标准件的文档,因此预计在那个地方,在其特定的名称,以及需要在狮身人面像访问独立。这些文件需要,因为它们是由狮身人面像建立完整的文档时,除了其中包括逐字版权声明和许可证文本处理,有效的重组文本。
README.txt文件:的包的目的,内容和用法的概述,这将是文档的索引页的页面的PyPI和组成部分。这应该是跟上最新在任何时候包内容。
CHANGES.txt:需要与相关的包的用户的任何改变包进行更新的更改日志。该文件的格式是由zest.releaser和它的当前版本(即“尖”的版本在公共Mercurial库)将从PyPI上页和内置包文档指出的理解。
ABOUT.txt:关于包装和它的作者,如后者的电子邮件地址和包的文档的URL,网页的PyPI,问题跟踪和源代码,以及当前日志的一些指针。据推测,文件将被无论是在PyPI中,并在公布;你应该确保使用分配给您的项目的正确网址分别。
COPYRIGHT.txt:版权信息的包:版权持有人,包括版权年,关于所使用的许可证,这是Zope的公共许可证2.1版在默认情况下一些建议。编辑该至少更新年。
LICENSE.TXT:使用许可证的正式文本的副本。不要编辑此除了换取不同的许可证。
完整的文档,内置使用狮身人面像
商务部:一切,仅仅是相关的狮身人面像,生成的文档。我们使用后缀名为.txt的狮身人面像输入文件。而对于doc目录中的内容存在的一些公约,没有什么大不了的事情,如果你随意修改包的休息;只要确保它仍然有效狮身人面像的输入。
DOC / conf.py:狮身人面像的配置。基本上所有的配置值遵循惯例,因此从tl.pkg进口的,所以你必须保持完好tl.pkg.sphinxconf的进口和调用。你必须编辑这个文件,如果你想改变一些关于元数据或文档的只是这个包的外观。更新到约定狮身人面像生成的文档将通过升级tl.pkg收购。
DOC /看到index.txt:文档的头版。它包括从顶层README.txt文件和目录指向完整文档的各部分表中的包的概述。这些措施包括生成API文档,关于包和更改日志的一些元数据信息。如果你想添加的顶层部分,例如编辑这个文件。
DOC / narrative.txt:
&NBSP;叙事包文件的根文件。这是为了收集任何驻留在你的源代码树的Python模块中的doc-测试文件。你需要列出下toctree指令的文件,其文件名是格局 - <文件名>(不带.txt后缀)。一个注释掉的示例文件清单也包括在内。
DOC / api.txt:生成的API文档的根文件。该API文档是半自动的,你必须在这个文件中列出,在自动摘要指令,将记录所有的模块,从那时起自动发生。一个注释掉的示例模块房源被包括在内。
DOC / OVERVIEW.TXT:
&NBSP; A存根包括顶级readme.txt文件。无需编辑该文件。
DOC / about.txt:关于包的元信息,结合顶层文件ABOUT.txt,COPYRIGHT.txt和LICENSE.TXT。你不会需要编辑这个文件。
DOC / changes.txt:
&NBSP; A存根包括顶层文件CHANGES.txt。无需编辑该文件。
DOC / requirements.pip:
&NBSP; Python的鸡蛋的上市打造的文件要求(比狮身人面像本身除外)。这意味着,在建筑的文档。你需要与他们为了能够使用由tl.pkg实现的约定列入白名单。编辑这个文件时,您的文档的包依赖关系变化;你不能用鸡蛋演员在这里。
构建完整的文档
生成的扩建配置在斌/ DOC调用狮身人面像建造的文件安装的脚本。要运行此脚本,当前工作目录必须是包根。该脚本会将内置文档进编译/ DOC /(相对于包的顶级目录)。传递给斌/ DOC选项将在底层狮身人面像-build命令过去了,但请注意,位置参数将无法正常工作。
狮身人面像的配置值
默认情况下,一些狮身人面像的扩展被启用,所以你可能想在除了核心狮身人面像变量配置这些:
- sphinx.ext.autosummary
- sphinx.ext.viewcode
- sphinx.ext.inheritance_diagram
- sphinxcontrib.cheeseshop
- sphinxcontrib.issuetracker
你可以通过简单的设置在conf.py.各自变量覆盖从tl.pkg默认tl.pkg.sphinxconf.set_defaults的调用需要发生在最后:
source_suffix ='.foo'
进口tl.pkg.sphinxconf
tl.pkg.sphinxconf.set_defaults()
相反,sphinxconf尝试使用变量从conf.py计算值。如果指定了这些变量,那也必须做set_defaults调用之前。目前,该变量如下:
_year_started:项目启动一年的可选值。此默认为当前年(在文档的建设时间),但如果它被指定,并从当年不同,它是用来构建像“2001至2012年着有”版权声明。
_flattr_url:如果指定,这被认为是一个flattr的事情这个项目,并捐赠flattr的按钮将出现在完整文档的菜单栏顶部的URL。添加flattr的按钮的PyPI页,取消“支持项目”项ABOUT.txt并填写网址那里。
_issuetracker_offline:
&NBSP;如果设置为true值,该sphinxcontrib-issuetracker一体化的整合到位桶会被修改,以便建立文档和狮身人面像运行时,它不会试图访问服务器保持独立的网​​络接入。 (与其他跟踪器整合一直没有照顾至今。)这将禁用跟踪器集成一些功能,但保留,例如,认识到纯文本的问题号码issuetracker扩展的能力。
最后,tl.pkg.sphinxconf模块定义,你可以调用注册模拟模块,如果文件是要建一个系统上,如函数无法安装某些代码(如模块用C实现的):
tl.pkg.sphinxconf.register_mock_modules(“开罗”,“图形对象”,“GTK')

要求

  • 在Python的

显影剂的其他软件 Thomas Lotze

tl.testing
tl.testing

15 Apr 15

Ophelia
Ophelia

15 Apr 15

意见 tl.pkg

评论没有发现
添加评论
打开图片!