Merge pull request #2 from JT-Ushio/master

fix(doc): fix read_the_docs build online documentation bugs.
AntNLP · Dec 28, 2018 · 37d2d02 · 37d2d02
2 parents 1819cfd + 61bcfd9
commit 37d2d02
Show file tree

Hide file tree

Showing 4 changed files with 12 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -21,4 +21,5 @@ Universal data IO and neural network modules in NLP tasks.
 # Resources
 
 + [Documentation](https://wait)
-+ [Source Code](https://github.com/AntNLP/antu)
++ [Source Code](https://github.com/AntNLP/antu)
+
diff --git a/doc/source/conf.py b/doc/source/conf.py
@@ -42,7 +42,6 @@
     'sphinx.ext.autodoc',
     'sphinx.ext.doctest',
     'sphinx.ext.intersphinx',
-    'sphinx.ext.imgmath',
     'sphinx.ext.mathjax',
     'sphinx.ext.viewcode',
     'sphinx.ext.coverage',

diff --git a/doc/source/index.rst b/doc/source/index.rst
@@ -6,6 +6,11 @@
 Welcome to antu's documentation!
 ================================
 
+Universal data IO and neural network modules in NLP tasks.
+
+* *data IO is an universal module in Natural Language Processing system and not based on any framework (like TensorFlow, PyTorch, MXNet, Dynet...).
+* *neural network module contains the neural network structures commonly used in NLP tasks. We want to design commonly used structures for each neural network framework. We will continue to develop this module.
+
 .. toctree::
    :maxdepth: 2
    :caption: Contents:

diff --git a/requirements.txt b/requirements.txt
@@ -0,0 +1,5 @@
+bidict==0.17.5
+numpy==1.15.4
+numpydoc==0.8.0
+overrides==1.9
+pytest==4.0.2