浏览代码

Add basic documentation

Thibaud Colas 7 年之前
父节点
当前提交
ab0dc7b2f6
共有 1 个文件被更改,包括 12 次插入0 次删除
  1. 12 0
      api.py

+ 12 - 0
api.py

@@ -1,4 +1,16 @@
 # -*- coding: utf-8 -*-
+#
+# This script parses the README.md and generates a machine-readable
+# data structure from it, for publication as an API.
+#
+# https://springload.github.io/awesome-wagtail/api/v1/readme.json
+#
+# It is automatically ran as part of Travis builds, also validating the README
+# formatting, and the API endpoint is deployed on successful builds on master.
+#
+# See also:
+# - https://djangopackages.org/api/v3/grids/wagtail-cms/
+# - https://github.com/awesomerank/rank
 
 from __future__ import absolute_import, unicode_literals