upgrade to 0.0.14

.gitignore

@@ -110,8 +110,11 @@ test.html
 
 best.html
 best_zh.html
+best1.html
 best2.html
 best3.html
+best4.html
+best5.html
 
 example.html
 

README.md

@@ -114,9 +114,16 @@ doc.add_api(
 )
 
 
-# 第6步，使用 build 方法构建生成文档，最后产出 html 文件
+# 第6步，添加文档结尾，markdown 格式
+doc.ending = """
+This is the end of document, **thankyou**!
+"""
+
+
+# 第7步，使用 build 方法构建生成文档，最后产出 html 文件
 doc.build('best.html')
 
+
 ```
 
 
@@ -138,6 +145,9 @@ python demo.py
 # 指定 language 为 zh，构建中文文档
 doc.build('best_zh.html', language='zh')
 
+# 自定义文档模版
+doc.template = 'eave/template.html'
+doc.build('best1.html')
 
 # 将文档对象导出为 json
 json_data = doc.to_json()
@@ -147,26 +157,22 @@ doc2 = Doc(json_data)
 doc2.title = 'My Second Api Document'
 doc2.build('best2.html')
 
-
 # 将文档对象导出为 yaml
 yaml_data = doc.to_yaml()
 
 # 导入 yaml 创建文档对象
 doc3 = Doc(yaml_data)
 doc3.build('best3.html')
 
-
 # 使用 raml 创建文档对象（不完全支持 raml）
 from eave.utils import raml2eave
 doc = raml2eave('example.raml')
 doc.build('example.html', 'zh')
 
-
-# 通过 from_md 参数，引入单独编写的 markdown 文件作为文档内容
+# 在添加 api 时，也通过 from_md 参数，引入单独编写的 markdown 文件作为文档内容
 doc.add_api(
     title="获取订单列表接口",
     uri="/orders/list/",
     from_md="orders.md",
 )
-
 ```

best_practice.py

@@ -78,7 +78,13 @@
 )
 
 
-# 第6步，使用 build 方法构建生成文档，最后产出 html 文件
+# 第6步，添加文档结尾，markdown 格式
+doc.ending = """
+This is the end of document, **thankyou**!
+"""
+
+
+# 第7步，使用 build 方法构建生成文档，最后产出 html 文件
 doc.build('best.html')
 
 
@@ -87,6 +93,11 @@
 # 指定 language 为 zh，构建中文文档
 doc.build('best_zh.html', language='zh')
 
+# 自定义文档模版
+import os
+print(os.getcwd())
+doc.template = 'eave/template.html'
+doc.build('best1.html')
 
 # 将文档对象导出为 json
 json_data = doc.to_json()
@@ -96,17 +107,22 @@
 doc2.title = 'My Second Api Document'
 doc2.build('best2.html')
 
-
 # 将文档对象导出为 yaml
 yaml_data = doc.to_yaml()
 
 # 导入 yaml 创建文档对象
 doc3 = Doc(yaml_data)
 doc3.build('best3.html')
 
-
 # 使用 raml 创建文档对象（不完全支持 raml）
 from eave.utils import raml2eave
 doc = raml2eave('example.raml')
 doc.build('example.html', 'zh')
 
+# 在添加 api 时，也通过 from_md 参数，引入单独编写的 markdown 文件作为文档内容
+doc.add_api(
+    title="获取订单列表接口",
+    uri="/orders/list/",
+    from_md="orders.md",
+)
+

eave/eave.py

@@ -65,15 +65,19 @@ class Doc(Base):
     description = ''
     notes = None
     apis = None
+    ending = ''
+    template = ''
 
     def __init__(self, *args, **kwargs):
         super().__init__(*args, **kwargs)
         self.notes = self.notes or []
         self.apis = self.apis or []
 
     def build(self, target=None, language='en'):
-        # language: zh, en ...
-        template = open(os.path.join(BASE_DIR, 'template.html'), encoding='utf8').read()
+        # language: zh / en ...
+        if not self.template:
+            self.template = os.path.join(BASE_DIR, 'template.html')
+        template = open(self.template, encoding='utf8').read()
         html = Template(template, strip=False).expand(
             doc=self, markdown=mistune.markdown, resource=RESOURCE, language=language)
         if target:
@@ -96,6 +100,7 @@ def load_data(self, data):
         self.version = data.get('version', self.version)
         self.host = data.get('host', self.host)
         self.description = data.get('description', self.description)
+        self.ending = data.get('ending', self.ending)
 
         notes = data.get('notes')
         apis = data.get('apis')
@@ -114,6 +119,7 @@ def to_dict(self):
             'description': self.description,
             'notes': [n.to_dict() for n in self.notes],
             'apis': [a.to_dict() for a in self.apis],
+            'ending': self.ending,
         }
 
 

eave/template.html

@@ -280,7 +280,10 @@ <h1 id="{{api.id}}">{{api.title}}</h1>
 
       %endfor
 
-
+      %if doc.ending:
+        <p>{{markdown(doc.ending, escape=False)}}</p>
+        <hr>
+      %endif
 
     </div>
 

setup.py

@@ -18,7 +18,7 @@
 
 setup(
     name='eave',
-    version='0.0.13',
+    version='0.0.14',
     description='A Restful Api Document Builder For Pythonista',
     long_description=long_description,
     long_description_content_type="text/markdown",