Copy

Author: kounelisagis

doc/source/conf.py

@@ -44,11 +44,14 @@
     "sphinx.ext.autodoc",
     "sphinx.ext.doctest",
     "sphinx.ext.intersphinx",
-    "sphinxcontrib.jquery",
+    "sphinx.ext.napoleon",
     "sphinx.ext.autosummary",
-    "sphinx.ext.viewcode",
+    "nbsphinx",
+    "sphinxcontrib.jquery",
 ]
 
+autosummary_generate = True
+
 # Mapping for linking between RTD subprojects.
 if readthedocs:
     intersphinx_mapping = {
@@ -67,6 +70,8 @@
         ),
     }
 
+napoleon_custom_sections = ["Lifecycle"]
+
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ["_templates"]
 
@@ -79,30 +84,40 @@
 # 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 = "sphinx"
+pygments_style = "friendly"
 
 
 # -- Options for HTML output -------------------------------------------------
 
 html_static_path = ["_static"]
-html_title = "TileDB Python API Reference — TileDB-Py %s documentation" % version
 html_logo = "_static/[email protected]"
 html_favicon = "_static/favicon.ico"
-html_use_index = False
 
-if not readthedocs:  # only import and set the theme if we're building docs locally
-    import sphinx_rtd_theme
+# if readthedocs:
+#     html_theme = "default"
+# else:
+#     import sphinx_rtd_theme
+#
+#     html_theme = "sphinx_rtd_theme"
+#     html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
+
+import sphinx_rtd_theme
 
-    html_theme = "sphinx_rtd_theme"
-    html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
-else:
-    html_theme = "default"
+html_theme = "sphinx_rtd_theme"
+html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
 
 # -- Options for HTMLHelp output ---------------------------------------------
 

doc/source/gensidebar.py

@@ -1,20 +1,18 @@
 #
-# This file generates the sidebar/toctree for all TileDB projects and should
+# This file generates the sidebar/toctree for all TileDB-SOMA projects and should
 # be copied to each project when it is updated.
 #
 # This file is originally from the RobotPy documentation project
 # https://github.com/robotpy/robotpy-docs, licensed under Apache v2.
 #
 
-import os
-
 
 def write_if_changed(fname, contents):
 
     try:
         with open(fname, "r") as fp:
             old_contents = fp.read()
-    except:
+    except Exception:
         old_contents = ""
 
     if old_contents != contents: