update docs

.gitignore

@@ -168,4 +168,9 @@ cython_debug/
 # for local testing
 te.py
 
+*/syslogs/*
+*/source/*
+*/sources/*
+*/source_tes/*
+setup.py
 */syslogs/*

docs/conf.py

@@ -0,0 +1,77 @@
+# -*- coding:utf-8 -*-
+##############################################################
+# Created Date: Friday, June 30th 2023
+# Contact Info: [email protected]
+# Author/Copyright: Mr. Xiangyong Luo
+##############################################################
+
+
+import sys
+from pathlib import Path
+
+home_dir = Path(__file__).parent.parent.parent.absolute()
+sys.path.insert(0, str(home_dir))
+# sys.path.insert(0, str(home_dir / 'my_readthedocs'))
+from multiproject.utils import get_project
+
+# -- Project information -----------------------------------------------------
+project = 'pyufunc Guide'
+copyright = '2023-, Xiangyong Luo'
+author = 'Xiangyong Luo'
+
+# The full version, including alpha/beta/rc tags
+release = '0.1.3'
+
+
+# 'sphinx.ext.napoleon'
+extensions = [
+    'sphinx.ext.autodoc',
+    'sphinx.ext.napoleon',
+    "hoverxref.extension",
+    "multiproject",
+    "myst_parser",
+    "notfound.extension",
+    "sphinx_copybutton",
+    "sphinx_design",
+    "sphinx_search.extension",
+    "sphinx_tabs.tabs",
+    "sphinx-prompt",
+    "sphinx.ext.autodoc",
+    "sphinx.ext.autosectionlabel",
+    "sphinx.ext.extlinks",
+    "sphinx.ext.intersphinx",
+    "sphinxcontrib.httpdomain",
+    "sphinxcontrib.video",
+    "sphinxemoji.sphinxemoji",
+    "sphinxext.opengraph"]
+
+
+multiproject_projects = {
+    "user": {
+        "use_config_file": False,
+        "config": {
+            "project": "Read the Docs user documentation",
+            "html_title": "Read the Docs user documentation",
+        },
+    },
+    "dev": {
+        "use_config_file": False,
+        "config": {
+            "project": "Read the Docs developer documentation",
+            "html_title": "Read the Docs developer documentation",
+        },
+    },
+}
+root_doc = 'index'
+language = 'en'
+source_suffix = {'.rst': 'restructuredtext'}
+
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = []
+html_static_path = []
+
+# html_theme = "sphinx_rtd_theme"
+
+# -- Options for EPUB output
+epub_show_urls = 'footnote'

docs/source/conf.py

@@ -7,34 +7,256 @@
 
 
 import sys
+import os
 from pathlib import Path
 
 home_dir = Path(__file__).parent.parent.parent.absolute()
 sys.path.insert(0, str(home_dir))
 # sys.path.insert(0, str(home_dir / 'my_readthedocs'))
+from multiproject.utils import get_project
 
+# 'sphinx.ext.napoleon'
+extensions = [
+    'sphinx.ext.autodoc',
+    'sphinx.ext.napoleon',
+    "hoverxref.extension",
+    "multiproject",
+    "myst_parser",
+    "notfound.extension",
+    "sphinx_copybutton",
+    "sphinx_design",
+    "sphinx_search.extension",
+    "sphinx_tabs.tabs",
+    "sphinx-prompt",
+    "sphinx.ext.autodoc",
+    "sphinx.ext.autosectionlabel",
+    "sphinx.ext.extlinks",
+    "sphinx.ext.intersphinx",
+    "sphinxcontrib.httpdomain",
+    "sphinxcontrib.video",
+    "sphinxemoji.sphinxemoji",
+    "sphinxext.opengraph"]
+
+
+multiproject_projects = {
+    "user": {
+        "use_config_file": False,
+        "config": {
+            "project": "Read the Docs user documentation",
+            "html_title": "Read the Docs user documentation",
+        },
+    },
+    "dev": {
+        "use_config_file": False,
+        "config": {
+            "project": "Read the Docs developer documentation",
+            "html_title": "Read the Docs developer documentation",
+        },
+    },
+}
+
+# specify doc set
+docset = get_project(multiproject_projects)
+
+ogp_site_name = "Read the Docs Documentation"
+ogp_use_first_image = True  # https://github.com/readthedocs/blog/pull/118
+ogp_image = "https://docs.readthedocs.io/en/latest/_static/img/logo-opengraph.png"
+# Inspired by https://github.com/executablebooks/MyST-Parser/pull/404/
+ogp_custom_meta_tags = [
+    '<meta name="twitter:card" content="summary_large_image" />',
+]
+ogp_enable_meta_description = True
+ogp_description_length = 300
+
+templates_path = ["_templates"]
+
+# This may be elevated as a general issue for documentation and behavioral
+# change to the Sphinx build:
+# This will ensure that we use the correctly set environment for canonical URLs
+# Old Read the Docs injections makes it point only to the default version,
+# for instance /en/stable/
+html_baseurl = os.environ.get("READTHEDOCS_CANONICAL_URL", "/")
 
 # -- Project information -----------------------------------------------------
-project = 'pyufunc Guide'
-copyright = '2023-, Xiangyong Luo'
+project = 'PyUFunc Guide'
 author = 'Xiangyong Luo'
 
 # The full version, including alpha/beta/rc tags
-release = '0.0.1'
+master_doc = "index"
+copyright = "2023-, Xiangyong Luo"
+version = '0.1.3'
+release = version
+exclude_patterns = ["_build", "shared", "_includes"]
+default_role = "obj"
+intersphinx_cache_limit = 14  # cache for 2 weeks
+intersphinx_timeout = 3  # 3 seconds timeout
+intersphinx_mapping = {
+    "python": ("https://docs.python.org/3.10/", None),
+    "django": (
+        "https://docs.djangoproject.com/en/stable/",
+        "https://docs.djangoproject.com/en/stable/_objects/",
+    ),
+    "sphinx": ("https://www.sphinx-doc.org/en/master/", None),
+    "pip": ("https://pip.pypa.io/en/stable/", None),
+    "nbsphinx": ("https://nbsphinx.readthedocs.io/en/latest/", None),
+    "myst-nb": ("https://myst-nb.readthedocs.io/en/stable/", None),
+    "ipywidgets": ("https://ipywidgets.readthedocs.io/en/stable/", None),
+    "jupytext": ("https://jupytext.readthedocs.io/en/stable/", None),
+    "ipyleaflet": ("https://ipyleaflet.readthedocs.io/en/latest/", None),
+    "poliastro": ("https://docs.poliastro.space/en/stable/", None),
+    "myst-parser": ("https://myst-parser.readthedocs.io/en/stable/", None),
+    "writethedocs": ("https://www.writethedocs.org/", None),
+    "jupyterbook": ("https://jupyterbook.org/en/stable/", None),
+    "executablebook": ("https://executablebooks.org/en/latest/", None),
+    "rst-to-myst": ("https://rst-to-myst.readthedocs.io/en/stable/", None),
+    "rtd": ("https://docs.readthedocs.io/en/stable/", None),
+    "rtd-dev": ("https://dev.readthedocs.io/en/latest/", None),
+    "rtd-blog": ("https://blog.readthedocs.com/", None),
+    "jupyter": ("https://docs.jupyter.org/en/latest/", None),
+}
 
+# Intersphinx: Do not try to resolve unresolved labels that aren't explicitly prefixed.
+# The default setting for intersphinx_disabled_reftypes can cause some pretty bad
+# breakage because we have rtd and rtd-dev stable versions in our mappings.
+# Hence, if we refactor labels, we won't see broken references, since the
+# currently active stable mapping keeps resolving.
+# Recommending doing this on all projects with Intersphinx.
+# https://www.sphinx-doc.org/en/master/usage/extensions/intersphinx.html#confval-intersphinx_disabled_reftypes
+intersphinx_disabled_reftypes = ["*"]
 
-# 'sphinx.ext.napoleon'
-extensions = ['sphinx.ext.autodoc', 'sphinx.ext.napoleon']
-root_doc = 'index'
-language = 'en'
-source_suffix = {'.rst': 'restructuredtext'}
+myst_enable_extensions = [
+    "deflist",
+]
+hoverxref_intersphinx = [
+    "sphinx",
+    "pip",
+    "nbsphinx",
+    "myst-nb",
+    "ipywidgets",
+    "jupytext",
+]
+htmlhelp_basename = "ReadTheDocsdoc"
+latex_documents = [
+    (
+        "index",
+        "ReadTheDocs.tex",
+        "Read the Docs Documentation",
+        "Eric Holscher, Charlie Leifer, Bobby Grace",
+        "manual",
+    ),
+]
+man_pages = [
+    (
+        "index",
+        "read-the-docs",
+        "Read the Docs Documentation",
+        ["Eric Holscher, Charlie Leifer, Bobby Grace"],
+        1,
+    )
+]
+
+language = "en"
+
+
+locale_dirs = [
+    f"{docset}/locale/",
+]
+gettext_compact = False
 
+html_theme = "sphinx_rtd_theme"
+html_static_path = ["_static", f"{docset}/_static"]
+html_css_files = ["css/custom.css", "css/sphinx_prompt_css.css"]
+html_js_files = ["js/expand_tabs.js"]
 
-# Add any paths that contain templates here, relative to this directory.
-templates_path = []
-html_static_path = []
+if os.environ.get("READTHEDOCS_VERSION_TYPE") == "external":
+    html_js_files.append("js/readthedocs-doc-diff.js")
 
-# html_theme = "sphinx_rtd_theme"
+html_logo = "_static/img/logo.svg"
+html_theme_options = {
+    "logo_only": True,
+    "display_version": False,
+}
+html_context = {
+    # Fix the "edit on" links.
+    # TODO: remove once we support different rtd config
+    # files per project.
+    "conf_py_path": f"/docs/{docset}/",
+    # Use to generate the Plausible "data-domain" attribute from the template
+    "plausible_domain": f"{os.environ.get('READTHEDOCS_PROJECT')}.readthedocs.io",
+}
+
+hoverxref_auto_ref = True
+hoverxref_domains = ["py"]
+hoverxref_roles = [
+    "option",
+    # Documentation pages
+    # Not supported yet: https://github.com/readthedocs/sphinx-hoverxref/issues/18
+    "doc",
+    # Glossary terms
+    "term",
+]
+hoverxref_role_types = {
+    "mod": "modal",  # for Python Sphinx Domain
+    "doc": "modal",  # for whole docs
+    "class": "tooltip",  # for Python Sphinx Domain
+    "ref": "tooltip",  # for hoverxref_auto_ref config
+    "confval": "tooltip",  # for custom object
+    "term": "tooltip",  # for glossaries
+}
+
+# See dev/style_guide.rst for documentation
+rst_epilog = """
+.. |org_brand| replace:: Read the Docs Community
+.. |com_brand| replace:: Read the Docs for Business
+.. |git_providers_and| replace:: GitHub, Bitbucket, and GitLab
+.. |git_providers_or| replace:: GitHub, Bitbucket, or GitLab
+"""
+
+# Activate autosectionlabel plugin
+autosectionlabel_prefix_document = True
+
+
+# sphinx-notfound-page
+# https://github.com/readthedocs/sphinx-notfound-page
+notfound_context = {
+    "title": "Page Not Found",
+    "body": """
+<h1>Page Not Found</h1>
+
+<p>Sorry, we couldn't find that page.</p>
+
+<p>Try using the search box or go to the homepage.</p>
+""",
+}
+linkcheck_retries = 2
+linkcheck_timeout = 1
+linkcheck_workers = 10
+linkcheck_ignore = [
+    r"http://127\.0\.0\.1",
+    r"http://localhost",
+    r"http://community\.dev\.readthedocs\.io",
+    r"https://yourproject\.readthedocs\.io",
+    r"https?://docs\.example\.com",
+    r"https://foo\.readthedocs\.io/projects",
+    r"https://github\.com.+?#L\d+",
+    r"https://github\.com/readthedocs/readthedocs\.org/issues",
+    r"https://github\.com/readthedocs/readthedocs\.org/pull",
+    r"https://docs\.readthedocs\.io/\?rtd_search",
+    r"https://readthedocs\.org/search",
+    # This page is under login
+    r"https://readthedocs\.org/accounts/gold",
+]
+
+extlinks = {
+    "rtd-issue": ("https://github.com/readthedocs/readthedocs.org/issues/%s", "#%s"),
+}
+
+# Disable epub mimetype warnings
+suppress_warnings = ["epub.unknown_project_files"]
+
+
+root_doc = 'index'
+source_suffix = {'.rst': 'restructuredtext'}
 
 # -- Options for EPUB output
 epub_show_urls = 'footnote'

pyufunc/pkg_configs.py

@@ -10,7 +10,7 @@
 
 
 # **** Package Info **** #
-pkg_version = "0.0.1"
+pkg_version = "0.1.3"
 pkg_name = "pyufunc"
 pkg_author = "Mr. Xiangyong Luo, Dr. Xuesong Simon Zhou"
 pkg_email = "[email protected], [email protected]"

pyufunc/util_log/logutils.py

@@ -209,7 +209,6 @@ def send_alert(self):
             self.error_tracker()
             message = "\n".join(self.mail_text_list)
 
-            a
             # the default length is 2, and more errors occur if len greater than 3
             if len(message) >= 3:
                 part1 = MIMEText(message, 'plain')