refactor: organize sections from cruft template

docs/source/conf.py

@@ -50,47 +50,11 @@
     "m2r2",
 ]
 
-# Turn on sphinx.ext.autosummary
-autodoc_default_options = {
-    "members": True,
-    "member-order": "bysource",
-    "special-members": "__init__",
-    "undoc-members": True,
-    "exclude-members": "__weakref__",
-    "autosummary": True,
-    "show-inheritance": True,
-}
-autodoc_typehints = "description"
-# autosummary_generate = True
-# autosummary_imported_members = True
-# numpydoc_show_class_members = False
-
-# Looks for objects in external projects
-intersphinx_mapping = {
-    "numpy": ("https://numpy.org/doc/stable/", None),
-    "scipy": ("https://docs.scipy.org/doc/scipy/reference/", None),
-    "quimb": ("https://quimb.readthedocs.io/en/latest/", None),
-    "tensornetwork": ("https://tensornetwork.readthedocs.io/en/latest/", None),
-    # "primme": ("https://www.cs.wm.edu/~andreas/software/doc/readme.html", None),
-}
-
-# Mathjax  (default values seem to be satisfactory enough)
-# mathjax_path = "https://cdn.jsdelivr.net/npm/[email protected]/es5/node-main.min.js"
-# mathjax2_config = {
-#     "tex": {
-#         "inlineMath": [["$", "$"], ["\\(", "\\)"]],
-#         "displayMath": [["$$", "$$"]],
-#         "processEscapes": True,
-#     },
-#     "options": {"ignoreHtmlClass": "document", "processHtmlClass": "math|output_area"}
-# }
-
 # 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"]
 
 # List of patterns, relative to source directory, that match files and
@@ -101,14 +65,17 @@
 # Allowing docstring in both __init__ and right under class definition
 autoclass_content = "both"
 
-
 # -- Options for HTML output -------------------------------------------------
 
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
-#
 html_theme = "sphinx_book_theme"
 
+# 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"]
+
 # 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.
@@ -123,46 +90,34 @@
     "use_download_button": False,
 }
 
-# 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"]
-
-
-# -- Options for LaTeX output ---------------------------------------------
-
-latex_elements = {  # type: ignore
-    # The paper size ('letterpaper' or 'a4paper').
-    # 'papersize': 'letterpaper',
-    # The font size ('10pt', '11pt' or '12pt').
-    # 'pointsize': '10pt',
-    # Additional stuff for the LaTeX preamble.
-    #  'preamble': '',
+# -- Options for Sphinx autosummary ------------------------------------------
+autodoc_default_options = {
+    "members": True,
+    "member-order": "bysource",
+    "special-members": "__init__",
+    "undoc-members": True,
+    "exclude-members": "__weakref__",
+    "autosummary": True,
+    "show-inheritance": True,
 }
+autodoc_typehints = "description"
+# autosummary_generate = True
+# autosummary_imported_members = True
+# numpydoc_show_class_members = False
 
-# 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 = [
-    ("index", "tnpy.tex", "tnpy Documentation", "Tan Tao-Lin", "manual"),
-]
-
-# The name of an image file (relative to this directory) to place at the top of
-# the title page.
-# latex_logo = None
-
-# For "manual" documents, if this is true, then toplevel headings are parts,
-# not chapters.
-# latex_use_parts = False
-
-# If true, show page references after internal links.
-# latex_show_pagerefs = False
-
-# If true, show URL addresses after external links.
-# latex_show_urls = False
-
-# Documents to append as an appendix to all manuals.
-# latex_appendices = []
+# -- Options for Mathjax -----------------------------------------------------
+# mathjax_path = "https://cdn.jsdelivr.net/npm/[email protected]/es5/node-main.min.js"
+# mathjax2_config = {
+#     "tex": {
+#         "inlineMath": [["$", "$"], ["\\(", "\\)"]],
+#         "displayMath": [["$$", "$$"]],
+#         "processEscapes": True,
+#     },
+#     "options": {"ignoreHtmlClass": "document", "processHtmlClass": "math|output_area"}
+# }
 
-# If false, no module index is generated.
-# latex_domain_indices = True
+# -- Link with documentation of external projects ----------------------------
+intersphinx_mapping = {
+    "numpy": ("https://numpy.org/doc/stable/", None),
+    "scipy": ("https://docs.scipy.org/doc/scipy/reference/", None),
+}