Documentation improvements: Add GitHub repository links, always display Unions with vertical bars, show default parameter values, don't display "Return type: None".

Author: fdxmw

docs/conf.py

@@ -51,11 +51,18 @@
 # This pattern also affects html_static_path and html_extra_path.
 exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
 
-primary_domain = "py"
-
 # Enable links to Python standard library classes (str, list, dict, etc).
 intersphinx_mapping = {"python": ("https://docs.python.org/3", None)}
 
+# sphinx_copybutton excludes line numbers, prompts, and outputs.
+copybutton_exclude = ".linenos, .gp, .go"
+
+# sphinx-autodoc-typehints configuration: Always display Unions with vertical bars,
+# show default values, and don't document :rtype: None.
+always_use_bars_union = True
+typehints_defaults = "comma"
+typehints_document_rtype_none = False
+
 # -- Options for HTML output -------------------------------------------------
 
 # The theme to use for HTML and HTML Help pages.  See the documentation for
@@ -64,6 +71,23 @@
 html_theme = "furo"
 html_theme_options = {
     "sidebar_hide_name": True,
+    # For view/edit this page buttons.
+    "source_repository": "https://github.com/UCSBarchlab/pyrtl",
+    "source_branch": "development",
+    "source_directory": "docs/",
+    # Add a GitHub repository link to the footer.
+    "footer_icons": [
+        {
+            "name": "GitHub",
+            "url": "https://github.com/UCSBarchlab/pyrtl",
+            "html": """
+                <svg stroke="currentColor" fill="currentColor" stroke-width="0" viewBox="0 0 16 16">
+                    <path fill-rule="evenodd" d="M8 0C3.58 0 0 3.58 0 8c0 3.54 2.29 6.53 5.47 7.59.4.07.55-.17.55-.38 0-.19-.01-.82-.01-1.49-2.01.37-2.53-.49-2.69-.94-.09-.23-.48-.94-.82-1.13-.28-.15-.68-.52-.01-.53.63-.01 1.08.58 1.23.82.72 1.21 1.87.87 2.33.66.07-.52.28-.87.51-1.07-1.78-.2-3.64-.89-3.64-3.95 0-.87.31-1.59.82-2.15-.08-.2-.36-1.02.08-2.12 0 0 .67-.21 2.2.82.64-.18 1.32-.27 2-.27.68 0 1.36.09 2 .27 1.53-1.04 2.2-.82 2.2-.82.44 1.1.16 1.92.08 2.12.51.56.82 1.27.82 2.15 0 3.07-1.87 3.75-3.65 3.95.29.25.54.73.54 1.48 0 1.07-.01 1.93-.01 2.2 0 .21.15.46.55.38A8.013 8.013 0 0 0 16 8c0-4.42-3.58-8-8-8z"></path>
+                </svg>
+            """,  # noqa: E501
+            "class": "",
+        },
+    ],
 }
 html_logo = "brand/pyrtl_logo.png"
 
@@ -72,6 +96,3 @@
 inheritance_graph_attrs = {
     "bgcolor": "aliceblue",
 }
-
-# The copy button excludes line numbers, prompts, and outputs.
-copybutton_exclude = ".linenos, .gp, .go"