update doc

docs/conf.py

@@ -1,15 +1,18 @@
+# -*- coding: utf-8 -*-
+#
 # Configuration file for the Sphinx documentation builder.
 #
-# This file only contains a selection of the most common options. For a full
-# list see the documentation:
-# https://www.sphinx-doc.org/en/master/usage/configuration.html
+# This file does only contain a selection of the most common options. For a
+# full list see the documentation:
+# http://www.sphinx-doc.org/en/master/config
 
 # -- Path setup --------------------------------------------------------------
 
 # If extensions (or modules to document with autodoc) are in another directory,
 # 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 sys
 from os.path import dirname, abspath
@@ -19,21 +22,23 @@
 
 version_path = os.path.join(suod_dir, 'suod', 'version.py')
 exec(open(version_path).read())
-
 # -- Project information -----------------------------------------------------
 
-project = 'SUOD'
-copyright = '2020, Yue Zhao'
+project = 'suod'
+copyright = '2021, Yue Zhao'
 author = 'Yue Zhao'
 
 # The short X.Y version
 version = __version__
 # The full version, including alpha/beta/rc tags
 release = __version__
 
-
 # -- General configuration ---------------------------------------------------
 
+# If your documentation needs a minimal Sphinx version, state it here.
+#
+# needs_sphinx = '1.0'
+
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
@@ -63,13 +68,16 @@
 # The master toctree document.
 master_doc = 'index'
 
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+#
 # This is also used if you do content translation via gettext catalogs.
 # Usually you set "language" from the command line for these cases.
 language = None
 
 # 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.
+# This pattern also affects html_static_path and html_extra_path .
 exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
 
 # The name of the Pygments (syntax highlighting) style to use.
@@ -80,20 +88,15 @@
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
 #
-html_theme = 'furo'
+# html_theme = 'default'
 
-# 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_theme = "furo"
 
-# -- Options for HTML output -------------------------------------------------
-
-# The theme to use for HTML and HTML Help pages.  See the documentation for
-# a list of builtin themes.
+# Theme options are theme-specific and customize the look and feel of a theme
+# further.  For a list of options available for each theme, see the
+# documentation.
 #
-# html_theme = 'alabaster'
-html_theme = 'default'
+# html_theme_options = {}
 
 # 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,
@@ -109,8 +112,8 @@
 # 'searchbox.html']``.
 #
 # html_sidebars = {}
-html_sidebars = {'**': ['globaltoc.html', 'relations.html', 'sourcelink.html',
-                        'searchbox.html']}
+# html_sidebars = {'**': ['globaltoc.html', 'relations.html', 'sourcelink.html',
+#                         'searchbox.html']}
 
 # -- Options for HTMLHelp output ---------------------------------------------
 
@@ -170,4 +173,4 @@
 # -- Options for intersphinx extension ---------------------------------------
 
 # Example configuration for intersphinx: refer to the Python standard library.
-intersphinx_mapping = {'https://docs.python.org/': None}
+intersphinx_mapping = {'https://docs.python.org/': None}

docs/index.rst

@@ -199,16 +199,12 @@ If you use SUOD in a scientific publication, we would appreciate citations to th
 
 ----
 
+
+
 .. rubric:: References
 
 .. bibliography::
    :cited:
+   :labelprefix: A
+   :keyprefix: a-
 
-
-
-Indices and tables
-==================
-
-* :ref:`genindex`
-* :ref:`modindex`
-* :ref:`search`

docs/requirements.txt

@@ -2,11 +2,13 @@ combo
 furo
 joblib
 matplotlib
-numpy>=1.13
-scipy>=0.19.1
-scikit_learn>=0.19.1
+nose
+numpy>=1.19
+numba>=0.51
+pytest
+scipy>=1.5.1
+scikit_learn>=0.22.0
+six
 sphinx-rtd-theme
 sphinxcontrib-bibtex
-pandas
-pyod
-docutils
+docutils