Merge pull request huggingface#1214 from huggingface/new-examples

Better examples
jozhang97 · Sep 9, 2019 · 995e38b · 995e38b
2 parents 3401980 + 3f91338
commit 995e38b
Show file tree

Hide file tree

Showing 6 changed files with 368 additions and 688 deletions.
diff --git a/docs/README.md b/docs/README.md
@@ -34,6 +34,13 @@ pip install recommonmark
 
 ## Building the documentation
 
+Make sure that there is a symlink from the `example` file (in /examples) inside the source folder. Run the followig 
+command to generate it:
+
+```bash
+ln -s ../../examples/README.md source/examples.md
+```
+
 Once you have setup `sphinx`, you can build the documentation by running the following command in the `/docs` folder:
 
 ```bash

diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -26,3 +26,4 @@ sphinxcontrib-jsmath==1.0.1
 sphinxcontrib-qthelp==1.0.2
 sphinxcontrib-serializinghtml==1.1.3
 urllib3==1.25.3
+sphinx-markdown-tables==0.0.9
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -43,7 +43,8 @@
     'sphinx.ext.coverage',
     'sphinx.ext.napoleon',
     'recommonmark',
-    'sphinx.ext.viewcode'
+    'sphinx.ext.viewcode',
+    'sphinx_markdown_tables'
 ]
 
 # Add any paths that contain templates here, relative to this directory.