Minor fixes

docs/examples/index.md

@@ -2,7 +2,7 @@
 
 In this section of the documentation, we will take you through some simple and more advanced topics related to building and running Calliope pathway optimisation models.
 
-The ["national scale" example][national-scale-example-model-pathway -ptimisation] builds a model for part of a national grid, exhibiting the following Calliope functionality:
+The ["national scale" example][national-scale-example-model-pathway-optimisation] builds a model for part of a national grid, exhibiting the following Calliope functionality:
 
 * Use of initial capacities.
 * Use of technology lifetimes that fall _between_ investment steps.

docs/examples/national_scale.py

@@ -16,7 +16,8 @@
 # %% [markdown]
 # # National scale example model pathway optimisation
 #
-# In this tutorial, we use the national scale example model to solve a pathway optimisation problem.
+# In this tutorial, we use the Calliope national scale example model to solve a pathway optimisation problem.
+# This model can be loaded in its non-pathway format within Calliope as `calliope.examples.national_scale()`.
 
 # %%
 

mkdocs.yml

@@ -34,6 +34,28 @@ plugins:
       include_source: True
       execute: true
       include_requirejs: true
+  - mkdocstrings:
+      default_handler: python
+      handlers:
+        python:
+          options:
+            show_bases: true
+            filters:
+              - "!^_"
+            heading_level: 1
+            show_root_heading: true
+            merge_init_into_class: true
+            show_if_no_docstring: true
+            signature_crossrefs: true
+            show_root_toc_entry: false
+            show_signature_annotations: false
+            inherited_members: true
+          paths: [src]
+          import:
+            - https://docs.python.org/3/objects.inv
+            - https://pandas.pydata.org/docs/objects.inv
+            - https://docs.xarray.dev/en/stable/objects.inv
+            - https://calliope.readthedocs.io/en/latest/objects.inv
 markdown_extensions:
   - admonition
   - attr_list