docs: modernize docs/sorce/conf.py for readability

Author: consideRatio

docs/source/conf.py

@@ -1,21 +1,20 @@
-#!/usr/bin/env python3
+# Configuration file for Sphinx to build our documentation to HTML.
 #
-# BinderHub documentation build configuration file, created by
-# sphinx-quickstart on Tue May 16 07:17:16 2017.
+# Configuration reference: https://www.sphinx-doc.org/en/master/usage/configuration.html
 #
-# This file is execfile()d with the current directory set to its
-# containing dir.
-#
-# Note that not all possible configuration values are present in this
-# autogenerated file.
-#
-# All configuration values have a default; values that are commented out
-# serve to show the default.
-
+import datetime
 import os
 import sys
 from os.path import dirname
 
+# -- Project information -----------------------------------------------------
+# ref: https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
+#
+project = "BinderHub"
+copyright = f"{datetime.date.today().year}, Project Jupyter Contributors"
+author = "Project Jupyter Contributors"
+
+
 # -- Setup system path for autodoc extensions --------------------------------
 #
 # We use autodoc to generate documentation in reference/, so we configure the
@@ -24,74 +23,33 @@
 git_repo_root = dirname(dirname(dirname(__file__)))
 sys.path.insert(0, git_repo_root)
 
-# -- General configuration ------------------------------------------------
 
-# If your documentation needs a minimal Sphinx version, state it here.
+# -- General Sphinx configuration ---------------------------------------------------
+# ref: https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
 #
-# needs_sphinx = '1.0'
-
-html_logo = "_static/images/logo.png"
-html_favicon = "_static/images/favicon.png"
-
-# Add any Sphinx extension module names here, as strings. They can be
-# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
-# ones.
 extensions = [
-    "sphinx.ext.autodoc",
-    "sphinx.ext.napoleon",
     "autodoc_traits",
-    "sphinx_copybutton",
     "myst_parser",
+    "sphinx_copybutton",
+    "sphinx.ext.autodoc",
+    "sphinx.ext.napoleon",
 ]
-
-# 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"]
-
-# The root toctree document.
 root_doc = "index"
-
-# Set the default role so we can use `foo` instead of ``foo``
+source_suffix = [".md", ".rst"]
 default_role = "literal"
-
-# General information about the project.
-project = "BinderHub"
-copyright = "2017, The Jupyter Team"
-author = "The Jupyter Team"
-
-# The version info for the project you're documenting, acts as replacement for
-# |version| and |release|, also used in various other places throughout the
-# built documents.
-#
-# The short X.Y version.
-version = "0.1"
-# The full version, including alpha/beta/rc tags.
-release = "0.1.0"
-
-# 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 patterns also effect to 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"
-
-# If true, `todo` and `todoList` produce output, else they produce nothing.
-todo_include_todos = False
+templates_path = ["_templates"]
 
 
-# -- Options for HTML output ----------------------------------------------
+# -- Options for HTML output -------------------------------------------------
+# ref: https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
+#
+html_logo = "_static/images/logo.png"
+html_favicon = "_static/images/favicon.png"
+html_static_path = ["_static"]
+html_css_files = ["custom.css"]
 
+# pydata_sphinx_theme reference: https://pydata-sphinx-theme.readthedocs.io/en/latest/
 html_theme = "pydata_sphinx_theme"
 html_theme_options = {
     "use_edit_page_button": True,
@@ -105,71 +63,11 @@
     "doc_path": "docs/source",
 }
 
-# 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_css_files = ["custom.css"]
-
-
-# -- Options for HTMLHelp output ------------------------------------------
-
-# Output file base name for HTML help builder.
-htmlhelp_basename = "BinderHubdoc"
-
-
-# -- Options for LaTeX output ---------------------------------------------
 
-latex_elements = {
-    # 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',
-}
-
-# Grouping the document tree into LaTeX files. List of tuples
-# (source start file, target name, title,
-#  author, documentclass [howto, manual, or own class]).
-latex_documents = [
-    (root_doc, "BinderHub.tex", "BinderHub Documentation", "Yuvi Panda", "manual"),
-]
-
-
-# -- Options for manual page output ---------------------------------------
-
-# One entry per manual page. List of tuples
-# (source start file, name, description, authors, manual section).
-man_pages = [(root_doc, "binderhub", "BinderHub Documentation", [author], 1)]
-
-
-# -- Options for Texinfo output -------------------------------------------
-
-# Grouping the document tree into Texinfo files. List of tuples
-# (source start file, target name, title, author,
-#  dir menu entry, description, category)
-texinfo_documents = [
-    (
-        root_doc,
-        "BinderHub",
-        "BinderHub Documentation",
-        author,
-        "BinderHub",
-        "One line description of project.",
-        "Miscellaneous",
-    ),
-]
-
-
-# -- Setup redirects for content that was moved internally
-# each entry represent an `old` path that is now available at a `new` path
+# -- Setup of redirects for internally relocated content  --------------------
+#
+# Each entry represent an `old` path that is now available at a `new` path
+#
 internal_redirects = [
     ("turn-off.html", "zero-to-binderhub/turn-off.html"),
     ("setup-registry.html", "zero-to-binderhub/setup-registry.html"),