Merge pull request #5 from TTWShell/release-docs

TTWShell · web-flow · commit 21fb3456a4e1 · 2018-09-26T09:18:24.000+08:00
release to readthedocs
diff --git a/Pipfile b/Pipfile
@@ -10,6 +10,10 @@ pypandoc = "*"
 tox = "*"
 pytest = "*"
 pytest-cov = "*"
+flask-sphinx-themes = "*"
+sphinx = "*"
+sphinx-autobuild = "*"
+recommonmark = "*"
 
 [dev-packages]
 
diff --git a/Pipfile.lock b/Pipfile.lock
diff --git a/README.md b/README.md
@@ -1,30 +1,13 @@
 # Hobbit-core
 
-一个生成 flask 项目的工具，包含基础工具集。
+A flask project generator.
 
-# Tree
+[Readmedocs](https://hobbit-core.readthedocs.io/en/latest/)
 
-    .
-    ├── demo
-    │   ├── __init__.py
-    │   ├── config.py
-    │   ├── exts.py
-    │   ├── models
-    │   │   ├── __init__.py
-    │   │   └── example.py
-    │   ├── run.py
-    │   ├── schemas
-    │   │   ├── __init__.py
-    │   │   └── example.py
-    │   ├── utils.py
-    │   └── views
-    │       ├── __init__.py
-    │       └── example.py
-    ├── docs
-    ├── requirements.txt
-    └── tests
-        ├── __init__.py
-        ├── conftest.py
-        └── test_example.py
+# Install
 
-#
+    pip install hobbit-core
+
+# Show help
+
+    hobbit --help
diff --git a/docs/index.rst b/docs/index.rst
@@ -1,8 +1,3 @@
-.. hobbit-core documentation master file, created by
-   sphinx-quickstart on Tue Sep 25 15:33:01 2018.
-   You can adapt this file completely to your liking, but it should at least
-   contain the root `toctree` directive.
-
 Welcome to hobbit-core's documentation!
 =======================================
 
diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -0,0 +1,5 @@
+Flask-Sphinx-Themes==1.0.2
+recommonmark==0.4.0
+Sphinx==1.8.1
+sphinx-autobuild==0.7.1
+
