jinja24doc 1.3.3

什么是Jinja24doc

jinja24doc是用于python模块的轻量级文档生成器 Jinja2模板。它是poor http组工具（wsgi连接器， wsgi/http服务器和mod_python连接器）。它可以加载模块并 其项目的文档。不需要配置，只需要Jinja2 模板。您的或来自Jinja2doc的包裹。

它更有powerful pydoc，具有您想要的样式。你可以格式化 通过wiki格式化，您的文档字符串带有一些简单的字符，其中 类似于asciidoc。或者可以使用标准的structuredText格式。两者 其中的标记分析器支持突出显示和创建自动链接 发送到pep。

几秒钟内完成文档记录

有三种工具供您使用： rst24doc， wiki24doc和 jinja24doc。 您可以使用中的工具rst24doc和wiki24doc生成这样的简单页面 一个命令：

# if your module use reStructuredText formating in documentation strings
~$ rst24doc -O your_module.html --embed-stylesheet your_module.py
# or if your module use wiki formating in documentation strings
~$ rst24doc -O your_module.html --embed-stylesheet your_module.py

或者您可以创建自己的模板，该模板从 Jinja24doc.您的template.html可以看到如下：

{%settitle='Your Module'%}{%setapi=load_module('your_module')%}{%include'_reference.html'%}

用正确的参数调用jinja24doc工具 python模块可用：

~$ jinja24doc --embed-stylesheet template.html > your_module.html

Jinja24doc作为库

有三个子模块您可以感兴趣：

• apidoc哪个 包含用于读取python模块和创建模块列表的基本apidoc类 按方法加载模块的项。
• rst包含 基于apidoc的rst类来解析structuredtext文档。
• wiki包含 基于apidoc的wiki类来解析wiki格式的文档。
• context哪个 包含基于rst和wiki的上下文类以耦合所有功能 使用Jinja2模板。
• frontend哪个 包含一些易于创建命令工具的函数，如rst24doc、wiki24doc 还有Jinja24doc。

~$ wget https://pypi.python.org/packages/source/j/jinja24doc/jinja24doc-1.3.3.tar.gz
~$ tar xzf jinja24doc-1.3.3.tar.gz
~$ cd jinja24doc-1.3.3
~$ python setup.py install

~$ git clone https://github.com/PoorHttp/Jinja24Doc.git
~$ cd Jinja24Doc
~$ python setup.py install

~$ pip install jinja24doc

~$ git clone clone https://github.com/PoorHttp/Jinja24Doc.git
~$ cd Jinja24Doc
~$ git checkout unstable
~$ python setup.py install

~$ wget https://github.com/PoorHttp/Jinja24Doc/archive/unstable.zip
~$ unzip unstable.zip
~$ cd Jinja24Doc-unstable
~$ python setup.py install