first commit to the repository with Sphinx build inside for HTML construction

2026-05-03 17:27:05 +08:00
parent e4366b8a6c
commit 802ab5115d
56 changed files with 5464 additions and 1 deletions
@@ -0,0 +1,47 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# For the full list of built-in configuration values, see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+# -- Project information -----------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
+
+project = 'mxpic_handbook'
+copyright = '2026, Qin Yue (PotatoMaxwell)'
+author = 'Qin Yue (PotatoMaxwell)'
+release = 'mxpic'
+
+# -- General configuration ---------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
+
+import os
+import sys
+sys.path.insert(0, os.path.abspath('..\\..\\'))  # Points to your mxpic code
+sys.path.insert(0, os.path.abspath('..\\'))  # Points to your mxpic code
+sys.path.insert(0, os.path.abspath('..\\..\\..\\'))  # Points to your mxpic code
+
+extensions = [
+    'sphinx.ext.autodoc',       # Automatically pull docstrings
+    'sphinx.ext.napoleon',      # Support for NumPy-style docstrings
+    'myst_parser',              # Support for Markdown[cite: 1]
+    'sphinx_autodoc_typehints', # Use your Python type hints[cite: 1]
+]
+
+source_suffix = {
+    '.rst': 'restructuredtext',
+    '.md': 'markdown',
+}
+
+templates_path = ['_templates']
+exclude_patterns = []
+
+# -- Options for HTML output -------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
+
+html_theme = "pydata_sphinx_theme"
+
+# Apply your mxPIC colors to the theme
+html_theme_options = {
+    "primary_color": "#6decff",
+    "accent_color": "#ff57c7",
+}