toy-example in docs, myst_nb configured, logo

Author: sarttiso

.gitignore

@@ -1,4 +1,5 @@
 **/.virtual_documents/
+graphics/logo.afdesign
 
 # Temporary and binary files
 *~
@@ -47,10 +48,14 @@ sdist/*
 docs/api/*
 docs/_rst/*
 docs/_build/*
+docs/jupyter_execute/*
 cover/*
 MANIFEST
 
 # Per-project virtualenvs
 .venv*/
 .conda*/
 .python-version
+
+# MyST build outputs
+_build

docs/conf.py

@@ -73,7 +73,16 @@
     "sphinx.ext.mathjax",
     "sphinx.ext.napoleon",
     "nbsphinx",
-    "sphinx_mdinclude"
+    "sphinx_mdinclude",
+    "myst_nb"
+]
+
+# myst_nb config
+nb_execution_mode = "off"
+myst_enable_extensions = [
+    "amsmath",          # For math environments like align
+    "dollarmath",       # For dollar-based math (e.g., $...$)
+    "colon_fence",      # For admonitions like :::note
 ]
 
 # Add any paths that contain templates here, relative to this directory.
@@ -124,7 +133,7 @@
 
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
-exclude_patterns = ["_build", "Thumbs.db", ".DS_Store", ".venv"]
+exclude_patterns = ["_build", "Thumbs.db", ".DS_Store", ".venv", ".virtual_documents/*"]
 
 # The reST default role (used for this markup: `text`) to use for all documents.
 # default_role = None

docs/readme.rst

@@ -1,2 +1,2 @@
 .. _readme:
-.. include:: ../README.rst
+.. include:: ../readme.md

docs/toy-example.ipynb

@@ -0,0 +1,5 @@
+# StratAge
+
+:::{figure} graphics/logo.png
+:align: left
+:width: 30%