update __version__ and some of docs/sourc/conf.py

btrdbextras/__init__.py

@@ -1,5 +1,5 @@
 from .conn import Connection
 
-__version__ = "v5.11.9"
+__version__ = "v5.31.0"
 
 __all__ = ["__version__", "Connection"]

docs/source/conf.py

@@ -1,8 +1,10 @@
+# -*- 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 --------------------------------------------------------------
 
@@ -17,17 +19,21 @@
 import os
 import sys
 
-sys.path.insert(0, os.path.abspath("../.."))
+import btrdbextras
 
-import sphinx_glpi_theme
+sys.path.insert(0, os.path.abspath("_themes"))
+sys.path.insert(0, os.path.abspath("../.."))
 
 # -- Project information -----------------------------------------------------
 
 project = "btrdbextras"
-copyright = "2020, PingThings, Inc."
+copyright = "2023, PingThings, Inc."
 author = "PingThings, Inc."
 
-
+# The short X.Y version
+version = btrdbextras.__version__
+# The full version, including alpha/beta/rc tags
+release = version
 # -- General configuration ---------------------------------------------------
 
 # Add any Sphinx extension module names here, as strings. They can be
@@ -36,18 +42,39 @@
 extensions = [
     "sphinx.ext.autodoc",
     "sphinx.ext.napoleon",
+    "sphinx.ext.todo",
     "sphinx.ext.githubpages",
     "sphinx.ext.intersphinx",
+    "numpydoc",
 ]
 
 # 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']
+source_suffix = ".rst"
+
+# 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 = "en"
+
 # 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 = ["build", "Thumbs.db", ".DS_Store"]
 
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = None
+
 
 # -- Options for HTML output -------------------------------------------------
 
@@ -56,6 +83,78 @@
 #
 
 
-html_theme = "glpi"
+html_theme = "alabaster"
+# html_theme = "sphinx_rtd_theme"
+html_theme = "pydata_sphinx_theme"
+
+# 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_options = {
+    "show_powered_by": False,
+    "github_user": "PingThingsIO",
+    "github_repo": "btrdbextras",
+    "travis_button": False,
+    "github_banner": False,
+    "show_related": False,
+    "note_bg": "#FFF59C",
+    "description": "An additional library of enhancements and features to "
+    "interact with the BTrDB database and Pingthings platform.",
+    "extra_nav_links": {"btrdb": "http://btrdb-python.readthedocs.io"},
+    "show_relbars": True,
+}
+
+# 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"]
+
+# Custom sidebar templates, must be a dictionary that maps document names
+# to template names.
+#
+# The default sidebars (for documents that don't match any pattern) are
+# defined by theme itself.  Builtin themes are using these templates by
+# default: ``['localtoc.html', 'relations.html', 'sourcelink.html',
+# 'searchbox.html']``.
+#
+# html_sidebars = {
+#     '**': [
+#         'sidebar.html',
+#         'localtoc.html',
+#         'relations.html',
+#         'searchbox.html',
+#     ],
+# }
+
+# -- Options for HTMLHelp output ---------------------------------------------
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = "btrdbextras"
+
+# -- Options for Epub output -------------------------------------------------
+
+# Bibliographic Dublin Core info.
+epub_title = project
+
+# The unique identifier of the text. This can be a ISBN number
+# or the project homepage.
+#
+# epub_identifier = ''
+
+# A unique identification for the text.
+#
+# epub_uid = ''
+
+# A list of files that should not be packed into the epub file.
+epub_exclude_files = ["search.html"]
+
+
+# -- Extension configuration -------------------------------------------------
+
+# -- Options for todo extension ----------------------------------------------
+
+# If true, `todo` and `todoList` produce output, else they produce nothing.
+todo_include_todos = True
 
-html_theme_path = sphinx_glpi_theme.get_html_themes_path()
+numfig = True