一个可重用的django应用程序，显示当前显示的视图的文档。文档是用markdown编写的，并以jquery模式显示。
django-online-docs的Python项目详细描述
Django应用程序，用于在 项目。
大多数大客户都要求使用Microsoft Word格式的用户文档。我们 认为这是疯狂的，因为我们以敏捷的方式开发web应用程序 这意味着这样的文件几乎马上就过时了。 还有一个问题是将最新的文档发送给所有用户，以便 我们想为什么不把文档放在页面上。为什么 不能使文档足够智能，只显示关于页面的文档 当前显示的。
此应用程序解析当前URL并尝试加载 当前以jquery模式显示的视图。文件只需要存储 在应用程序的/templates/online_docs/文件夹中。
请注意，这是第一个原型和概念证明 想法。这是非常简单的，可能违反干，不支持 I18N.不过，这已经在路线图上了。
当您在/docs/页面上单击 Docs导航链接：
安装
要使用此应用程序，您需要安装以下先决条件：
pip install Django pip install markdown
如果要安装pypi的最新稳定版本：
$ pip install django-online-docs
如果您有冒险精神并希望安装来自github的最新提交：
$ pip install -e git://github.com/bitmazk/django-online-docs.git#egg=online_docs
将online_docs和django.contrib.markdown添加到 INSTALLED_APPS：
INSTALLED_APPS = (
...,
'django.contrib.markdown',
'online_docs',
)
将此应用程序连接到您的urls.py：
urlpatterns = patterns('',
...
url(r'^docs/$',
include('online_docs.urls')),
)
下载jquery和jquery ui并将其放在/static/文件夹中。那么 将库和online_docs.js添加到base.html。此外 online_docs/css/styles.css将为输出提供一些简单的样式 降价会产生。您可以省略此样式表，只需添加 如果需要，可以将样式设置为自己的主样式表：
<head>
...
<!-- import the jquery-ui stylesheet here -->
<link rel="stylesheet" href="{{ STATIC_URL }}online_docs/css/styles.css">
...
</head>
<body>
...
<!-- Load these scripts before the closing <body> tag -->
<!-- Import jQuery here -->
<!-- Import jQuery-ui here -->
<script src="{{ STATIC_URL }}online_docs/js/online_docs.js"></script>
</body>
将打开文档的链接添加到base.html:
{% load online_docs_tags %}
...
<ul id="navigation">
...
<li>{% render_docs_link request %}</li>
</ul>
如果不喜欢docs链接的外观，可以重写 模板online_docs/online_docs_link.html。
你可以通过运行你的站点并访问 连接此应用程序的url（即/docs/?path=/docs/）。
用法
只需在应用程序中创建一个/templates/online_docs/文件夹 文件。然后将.md文件放在该文件夹中。文件名应该 格式为[namespace_]view_name（命名空间是可选的）。
如果要记录第三方应用程序的视图，只需创建 /templates/online_docs文件夹，位于项目的主静态文件夹和 把文件放进去。
如果您不确定文件名，只需运行应用程序，转到视图并 单击文档链接。如果有DEBUG=True，则错误消息将显示 您需要的文件名。
如果要引用文档中的其他文档，可以使用 模板标记url_cross_reference：
{% load online_docs_tags %}
{% url_cross_reference "filename.md" "Link text" %}
如果要在blocktrans标记中使用生成的链接，请执行以下操作 以下内容：
{% load online_docs_tags %}
{% url_cross_reference "filename.md" "Link text" as cross_link %}
{% blocktrans with cross_link=cross_link|safe %}
Foo bar {{ cross_link }}
{% endblocktrans %}
设置
联机文档调试
_默认值：FALSE
将其设置为true以查看当前视图的文档文件名 应该是。文件名将附加到呈现的文档输出中 当前视图的。如果你想知道文件名应该是什么， 只需单击docs链接并滚动到输出的底部。
贡献
如果您想参与此项目，请执行以下步骤：
# Fork this repository # Clone your fork $ mkvirtualenv -p python2.7 django-online-docs $ pip install -r requirements.txt $ ./online_docs/tests/runtests.sh # You should get no failing tests $ git co -b feature_branch master # Implement your feature and tests # Describe your change in the CHANGELOG.txt $ git add . && git commit $ git push origin feature_branch # Send us a pull request for your feature branch
无论何时运行测试，都会在 tests/coverage/index.html。添加新功能时，请确保 你把保险范围保持在100%。
哦…如果你提交的补丁使我们的测试失败，你将公开 在http://travis-ci.org/#!/bitmazk/django-online-docs；）上受辱
如果您正在进行需要在浏览器中测试的更改（即 css或js文件），您可能希望设置django项目，请按照 安装在上面的指令中，然后运行python setup.py develop。这个 只需在项目的virtualenv中放置一个到克隆叉的鸡蛋链接。
路线图
查看github上的问题跟踪程序，以了解未来的里程碑和功能。
欢迎加入QQ群-->： 979659372
