Update docs site configuration

doc-requirements.txt

@@ -1,3 +1,3 @@
-sphinx>=1.8.2
+sphinx==6.2.1
 doc8>=0.8.0
 sphinx_kidsfirst_theme @ git+https://github.com/kids-first/kf-sphinx-docs-theme.git

docs/source/conf.py

@@ -19,14 +19,14 @@
 
 # -- Project information -----------------------------------------------------
 
-project = 'Kids First Data Ingest Libraries'
-copyright = '2019, Kids First'
-author = 'Kids First'
+project = "Kids First Data Ingest Libraries"
+copyright = "2024, Kids First"
+author = "Kids First"
 
 # The short X.Y version
-version = '0.0.1'
+version = "0.0.1"
 # The full version, including alpha/beta/rc tags
-release = ''
+release = ""
 
 
 # -- General configuration ---------------------------------------------------
@@ -39,22 +39,22 @@
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
 extensions = [
-    'sphinx.ext.autodoc',
-    'sphinx.ext.viewcode',
-    'sphinx.ext.githubpages'
+    "sphinx.ext.autodoc",
+    "sphinx.ext.viewcode",
+    "sphinx.ext.githubpages",
 ]
 
 # Add any paths that contain templates here, relative to this directory.
-templates_path = ['_templates']
+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'
+source_suffix = ".rst"
 
 # The master toctree document.
-master_doc = 'index'
+master_doc = "index"
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
@@ -78,24 +78,22 @@
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
 #
-html_theme = 'sphinx_kidsfirst_theme'
+html_theme = "sphinx_kidsfirst_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 = {
-    'logo_only': True
-}
+html_theme_options = {"logo_only": 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']
+html_static_path = ["_static"]
 
-html_logo = '_static/images/logo.png'
+html_logo = "_static/images/logo.png"
 html_css_files = [
-    'other.css',
+    "other.css",
 ]
 
 
@@ -113,7 +111,7 @@
 # -- Options for HTMLHelp output ---------------------------------------------
 
 # Output file base name for HTML help builder.
-htmlhelp_basename = 'KidsFirstDataIngestLibrariesdoc'
+htmlhelp_basename = "KidsFirstDataIngestLibrariesdoc"
 
 
 # -- Options for LaTeX output ------------------------------------------------
@@ -122,15 +120,12 @@
     # The paper size ('letterpaper' or 'a4paper').
     #
     # 'papersize': 'letterpaper',
-
     # The font size ('10pt', '11pt' or '12pt').
     #
     # 'pointsize': '10pt',
-
     # Additional stuff for the LaTeX preamble.
     #
     # 'preamble': '',
-
     # Latex figure (float) alignment
     #
     # 'figure_align': 'htbp',
@@ -140,8 +135,13 @@
 # (source start file, target name, title,
 #  author, documentclass [howto, manual, or own class]).
 latex_documents = [
-    (master_doc, 'KidsFirstDataIngestLibraries.tex', 'Kids First Data Ingest Libraries Documentation',
-     'Kids First DRC, Natasha Singh, Avi Kelman', 'manual'),
+    (
+        master_doc,
+        "KidsFirstDataIngestLibraries.tex",
+        "Kids First Data Ingest Libraries Documentation",
+        "Kids First DRC, Natasha Singh, Avi Kelman",
+        "manual",
+    ),
 ]
 
 
@@ -150,8 +150,13 @@
 # One entry per manual page. List of tuples
 # (source start file, name, description, authors, manual section).
 man_pages = [
-    (master_doc, 'kidsfirstdataingestlibraries', 'Kids First Data Ingest Libraries Documentation',
-     [author], 1)
+    (
+        master_doc,
+        "kidsfirstdataingestlibraries",
+        "Kids First Data Ingest Libraries Documentation",
+        [author],
+        1,
+    )
 ]
 
 
@@ -161,9 +166,15 @@
 # (source start file, target name, title, author,
 #  dir menu entry, description, category)
 texinfo_documents = [
-    (master_doc, 'KidsFirstDataIngestLibraries', 'Kids First Data Ingest Libraries Documentation',
-     author, 'KidsFirstDataIngestLibraries', 'One line description of project.',
-     'Miscellaneous'),
+    (
+        master_doc,
+        "KidsFirstDataIngestLibraries",
+        "Kids First Data Ingest Libraries Documentation",
+        author,
+        "KidsFirstDataIngestLibraries",
+        "One line description of project.",
+        "Miscellaneous",
+    ),
 ]
 
 
@@ -182,7 +193,7 @@
 # epub_uid = ''
 
 # A list of files that should not be packed into the epub file.
-epub_exclude_files = ['search.html']
+epub_exclude_files = ["search.html"]
 
 
 # -- Extension configuration -------------------------------------------------