Merge pull request #81 from climate-resource/bump-mkdocs-jupyter

Bump mkdocs jupyter version
climate-resource · Nov 5, 2024 · bcea3a4 · bcea3a4
2 parents 9b8f7ea + cb51f96
commit bcea3a4
Show file tree

Hide file tree

Showing 6 changed files with 775 additions and 703 deletions.
diff --git a/changelog/81.trivial.md b/changelog/81.trivial.md
@@ -0,0 +1 @@
+Updated the version of mkdocs-jupyter to pull in the results of https://github.com/danielfrg/mkdocs-jupyter/pull/222.
diff --git a/docs/changelog.md b/docs/changelog.md
@@ -32,9 +32,9 @@ from the examples given in that link.
     the default value of which is [`input4mips_validation.dataset.dataset.prepare_ds_and_get_frequency`][].
     This makes the API simpler and gives the user more control.
     However, it is a breaking change.
-  - We removed fine-grained control of writing to disk when using [`Dataset.write`][input4mips_validation.dataset.Input4MIPsDataset.write]
+  - We removed fine-grained control of writing to disk when using [`Input4MIPsDataset.write`][input4mips_validation.dataset.Input4MIPsDataset.write]
     and [`input4mips_validation.io.write_ds_to_disk`][].
-    Instead, use [`Dataset.get_out_path_and_disk_ready_dataset`][input4mips_validation.dataset.Input4MIPsDataset.get_out_path_and_disk_ready_dataset]
+    Instead, use [`Input4MIPsDataset.get_out_path_and_disk_ready_dataset`][input4mips_validation.dataset.Input4MIPsDataset.get_out_path_and_disk_ready_dataset]
     or [`input4mips_validation.io.prepare_out_path_and_cubes`][] then write using you own writing function
     (typically [`iris.save`][] instead).
   - Renamed `bounds_dim` to `bounds_indicator` in [`input4mips_validation.dataset.dataset.handle_ds_standard_long_names`][].
@@ -43,7 +43,7 @@ from the examples given in that link.
 
 ### 🆕 Features
 
-- - Added [`Dataset.get_out_path_and_disk_ready_dataset`][input4mips_validation.dataset.Input4MIPsDataset.get_out_path_and_disk_ready_dataset]
+- - Added [`Input4MIPsDataset.get_out_path_and_disk_ready_dataset`][input4mips_validation.dataset.Input4MIPsDataset.get_out_path_and_disk_ready_dataset]
     and [`input4mips_validation.io.prepare_out_path_and_cubes`][]
     to permit finer-grained control of file preparation and writing.
   - Added [`input4mips_validation.dataset.dataset.add_bounds`][].

diff --git a/environment-docs.yml b/environment-docs.yml
@@ -180,7 +180,7 @@ dependencies:
   - mkdocs_autorefs==1.2.0
   - mkdocs_gen_files==0.5.0
   - mkdocs_get_deps==0.2.0
-  - mkdocs_jupyter==0.25.0
+  - mkdocs_jupyter==0.25.1
   - mkdocs_literate_nav==0.6.1
   - mkdocs_material==9.5.39
   - mkdocs_material_extensions==1.3.1