From 7429b30a13ea6f085b627c9031a46821089edb17 Mon Sep 17 00:00:00 2001 From: Santiago Soler Date: Tue, 19 Nov 2024 15:35:27 -0800 Subject: [PATCH] Update the table of contents (#38) Fix issue with broken table of contents: move the table of contents from the `_toc.yml` file to the `myst.yml` to match the new way in how MystMD handles the TOC. Remove the maximum constrain to `nodejs` since it was probably creating some issues. Fixes #36 --- _toc.yml | 61 ------------------------------------------------- environment.yml | 2 +- myst.yml | 41 +++++++++++++++++++++++++++++++++ 3 files changed, 42 insertions(+), 62 deletions(-) delete mode 100644 _toc.yml diff --git a/_toc.yml b/_toc.yml deleted file mode 100644 index 7135792..0000000 --- a/_toc.yml +++ /dev/null @@ -1,61 +0,0 @@ -# Table of Contents -# -# Myst will respect: -# 1. New pages -# - file: relative/path/to/page -# 2. New sections without an associated page -# - title: Folder Title -# sections: ... -# 3. New sections with an associated page -# - file: relative/path/to/page -# sections: ... -# -# Note: Titles defined on pages here are not recognized. -# -# This spec is based on the JupyterBook table of contents. -# Learn more at https://jupyterbook.org/customize/toc.html - -format: jb-book -root: index - -chapters: -# GRAVITY -- file: notebooks/gravity_index - sections: - - file: notebooks/03-gravity/fwd_gravity_anomaly_3d - - file: notebooks/03-gravity/fwd_gravity_gradiometry_3d - - file: notebooks/03-gravity/inv_gravity_anomaly_3d -# MAGNETICS -- file: notebooks/magnetics_index - sections: - - file: notebooks/04-magnetics/fwd_magnetics_induced_3d - - file: notebooks/04-magnetics/fwd_magnetics_mvi_3d - - file: notebooks/04-magnetics/inv_magnetics_induced_3d -# DC RESISTIVITY -- file: notebooks/dcr_index - sections: - - file: notebooks/05-dcr/fwd_dcr_1d - - file: notebooks/05-dcr/fwd_dcr_2d - - file: notebooks/05-dcr/fwd_dcr_3d - - file: notebooks/05-dcr/inv_dcr_1d - - file: notebooks/05-dcr/inv_dcr_2d - - file: notebooks/05-dcr/inv_dcr_3d -# INDUCED POLARIZATION -- file: notebooks/ip_index - sections: - - file: notebooks/06-ip/fwd_ip_2d - - file: notebooks/06-ip/fwd_ip_3d - - file: notebooks/06-ip/inv_ip_2d - - file: notebooks/06-ip/inv_ip_3d -# FDEM -- file: notebooks/fdem_index - sections: - - file: notebooks/07-fdem/fwd_fdem_1d - - file: notebooks/07-fdem/inv_fdem_1d -# TDEM -- file: notebooks/tdem_index - sections: - - file: notebooks/08-tdem/fwd_tdem_1d - - file: notebooks/08-tdem/fwd_tdem_fundamentals - - file: notebooks/08-tdem/fwd_utem_3d - - file: notebooks/08-tdem/inv_tdem_1d diff --git a/environment.yml b/environment.yml index b2bfc15..ba8c500 100644 --- a/environment.yml +++ b/environment.yml @@ -4,7 +4,7 @@ channels: dependencies: - python=3.10.* # Myst requirements - - nodejs>=20,<21 + - nodejs>18 - mystmd # Notebook requirements - jupyter diff --git a/myst.yml b/myst.yml index 8248a60..f260195 100644 --- a/myst.yml +++ b/myst.yml @@ -32,6 +32,47 @@ project: sphinx: https://www.sphinx-doc.org/en/master/ exclude: - README.md + - LICENSE + - LICENSE-CC-BY + - environment.yml + + toc: + - file: index.md + - file: notebooks/gravity_index.md + children: + - file: notebooks/03-gravity/fwd_gravity_anomaly_3d.ipynb + - file: notebooks/03-gravity/fwd_gravity_gradiometry_3d.ipynb + - file: notebooks/03-gravity/inv_gravity_anomaly_3d.ipynb + - file: notebooks/magnetics_index.md + children: + - file: notebooks/04-magnetics/fwd_magnetics_induced_3d.ipynb + - file: notebooks/04-magnetics/fwd_magnetics_mvi_3d.ipynb + - file: notebooks/04-magnetics/inv_magnetics_induced_3d.ipynb + - file: notebooks/dcr_index.md + children: + - file: notebooks/05-dcr/fwd_dcr_1d.ipynb + - file: notebooks/05-dcr/fwd_dcr_2d.ipynb + - file: notebooks/05-dcr/fwd_dcr_3d.ipynb + - file: notebooks/05-dcr/inv_dcr_1d.ipynb + - file: notebooks/05-dcr/inv_dcr_2d.ipynb + - file: notebooks/05-dcr/inv_dcr_3d.ipynb + - file: notebooks/ip_index.md + children: + - file: notebooks/06-ip/fwd_ip_2d.ipynb + - file: notebooks/06-ip/fwd_ip_3d.ipynb + - file: notebooks/06-ip/inv_ip_2d.ipynb + - file: notebooks/06-ip/inv_ip_3d.ipynb + - file: notebooks/fdem_index.md + children: + - file: notebooks/07-fdem/fwd_fdem_1d.ipynb + - file: notebooks/07-fdem/inv_fdem_1d.ipynb + - file: notebooks/tdem_index.md + children: + - file: notebooks/08-tdem/fwd_tdem_1d.ipynb + - file: notebooks/08-tdem/fwd_tdem_fundamentals.ipynb + - file: notebooks/08-tdem/fwd_utem_3d.ipynb + - file: notebooks/08-tdem/inv_tdem_1d.ipynb + site: template: book-theme title: SimPEG User Tutorials