[docs] add galleries

Author: tswsxk

docs/requirements.txt

@@ -1,3 +1,4 @@
 sphinx
 sphinx_rtd_theme
-sphinx_toggleprompt
+sphinx_toggleprompt
+sphinx-gallery>=0.6

docs/source/conf.py

@@ -10,10 +10,20 @@
 # add these directories to sys.path here. If the directory is relative to the
 # documentation root, use os.path.abspath to make it absolute, like shown here.
 #
-import os
+import os, shutil
 import sys
 sys.path.insert(0, os.path.abspath('../'))
 
+
+def copy_tree(src, tar):
+    if os.path.exists(tar):
+        shutil.rmtree(tar)
+    shutil.copytree(src, tar)
+
+
+copy_tree("../../examples", "build/blitz")
+copy_tree("../../asset", "build/asset")
+
 import sphinx_rtd_theme
 
 # -- Project information -----------------------------------------------------
@@ -22,7 +32,6 @@
 copyright = '2021, bigdata-ustc'
 author = 'bigdata-ustc'
 
-
 # -- General configuration ---------------------------------------------------
 
 # Add any Sphinx extension module names here, as strings. They can be
@@ -36,11 +45,26 @@
     'sphinx.ext.napoleon',
     'sphinx.ext.mathjax',
     'sphinx_toggleprompt',
+    'nbsphinx',
+    'sphinx_gallery.load_style'
 ]
 
+# extension variables setting
+# npsphinx
+
+nbsphinx_thumbnails = {
+    'build/blitz/sif/sif': '_static/EduNLP.png',
+}
+
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']
 
+# The suffix(es) of source filenames.
+# You can specify multiple suffix as a list of string:
+#
+source_suffix = ['.rst', '.md', '.ipynb']
+# source_suffix = '.rst'
+
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
 #
@@ -51,8 +75,7 @@
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
 # This pattern also affects html_static_path and html_extra_path.
-exclude_patterns = []
-
+exclude_patterns = ['_build']
 
 # -- Options for HTML output -------------------------------------------------
 
@@ -65,4 +88,4 @@
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = ['_static']
+html_static_path = ['_static']

docs/source/tutorial/zh/index.rst

@@ -10,3 +10,14 @@
   parse
   tokenize
   vectorization
+
+
+示例
+--------
+.. nbgallery::
+    :caption: This is a thumbnail gallery:
+    :name: gallery
+    :glob:
+    :reversed:
+
+    ../../build/blitz/sif/sif

setup.py

@@ -13,7 +13,8 @@
 docs_deps = [
     'sphinx',
     'sphinx_rtd_theme',
-    'sphinx_toggleprompt'
+    'sphinx_toggleprompt',
+    'sphinx-gallery>=0.6'
 ]
 
 dev_deps = ["requests"] + docs_deps + test_deps