Tutorial 6. Animations (#16)

* Add docs for tutorial 6 * Use sphinx.ext.extlinks for gmt-module links Xref https://www.sphinx-doc.org/en/master/usage/extensions/extlinks.html * Add sphinxcontrib-youtube Xref GenericMappingTools/gmt-examples#37 * Add sphinx_gmt.gmtplot Sphinx extension used to define the `gmtplot` directive that will execute the given GMT code and insert the generated figure into the document. Need to set `highlight_language: bash` otherwise there will be an `UnboundLocalError: cannot access local variable 'suffix' where it is not associated with a value`. --------- Co-authored-by: Wei Ji <[email protected]>
GenericMappingTools · Dec 2, 2024 · 68ae095 · 68ae095
1 parent a08f3ed
commit 68ae095
Show file tree

Hide file tree

Showing 5 changed files with 955 additions and 2 deletions.
diff --git a/book/_config.yml b/book/_config.yml
@@ -45,3 +45,13 @@ sphinx:
   config:
     bibtex_reference_style: author_year
     html_show_copyright: false
+    # Adjust highlight language for sphinx_gmt examples
+    highlight_language: bash
+    extlinks:
+      gmt-module:
+        - "https://docs.generic-mapping-tools.org/6.5/%s"
+        - "%s"
+  extra_extensions:
+    - sphinx.ext.extlinks
+    - sphinx_gmt.gmtplot
+    - sphinxcontrib.youtube
diff --git a/book/_toc.yml b/book/_toc.yml
@@ -15,4 +15,7 @@ parts:
   - file: markdown-notebooks
   - file: tut01_firstfigure
   - file: tut02_spe_pd_gpd
-  - file: tut03_spe_xarray
+  - file: tut03_spe_xarray
+  - file: tut06_animation
+    sections:
+      - file: tut06_animation_extended