Add link to rust benchmarks to the docs

docs/source/dev/README.rst

@@ -320,3 +320,13 @@ All test files (e.g. ``test_scenario.py``) should start/end with the following b
 
 This allows the (single) file to be executed, running only the tests contained
 within. This is extremely useful when updating/modifying/adding tests in the file.
+
+
+Rust Benchmarking
+^^^^^^^^^^^^^^^^^
+To ensure the routing algorithm remains performant, we have set up
+`Rust benchmarks <https://nrel.github.io/reVRt/dev/bench/index.html>`_
+that are automatically run on GitHub Actions on the main branch. If
+you are actively developing the Rust-based routing algorithm, you
+should monitor the benchmarks to ensure that your changes do not
+introduce performance regressions.

revrt/costs/dry_costs_creator.py

@@ -99,7 +99,7 @@ def build(  # noqa: PLR0913, PLR0917
             mask to the cost array.
         default_multipliers : dict | IsoMultipliers, optional
             Multipliers for regions not specified in the
-            `iso_region_tiff`. Must be a dictionary of the form:
+            `iso_region_tiff`. Must be a dictionary of the form::
 
                 "land_use": {
                     "cropland": 1.03,

revrt/spatial_characterization/cli.py

@@ -241,7 +241,7 @@ def _preprocess_stats_config(
               Statistics must be one of the members of
               :class:`~revrt.spatial_characterization.stats.Stat` or
               :class:`~revrt.spatial_characterization.stats.FractionalStat`,
-              or must start with the "percentile_" prefix and end with
+              or must start with the ``percentile_`` prefix and end with
               an int or float representing the percentile to compute
               (e.g. ``percentile_10.5``). If only one statistic is to be
               computed, you can provide it directly as a string.

revrt/spatial_characterization/stats.py

@@ -414,8 +414,8 @@ def from_iter(cls, stats=None):
         stats : str | iterable of str, optional
             Names of all statistics to compute. Statistics must be one
             of the members of :class:`Stat` or :class:`FractionalStat`,
-            or must start with the "percentile_" prefix and end with an
-            int or float representing the percentile to compute (e.g.
+            or must start with the ``percentile_`` prefix and end with
+            an int or float representing the percentile to compute (e.g.
             ``percentile_10.5``). If only one statistic is to be
             computed, you can provide it directly as a string.
             Otherwise, provide a list of statistic names or a string

revrt/spatial_characterization/zonal.py

@@ -39,8 +39,8 @@ def __init__(
             of the members of
             :class:`~revrt.spatial_characterization.stats.Stat` or
             :class:`~revrt.spatial_characterization.stats.FractionalStat`,
-            or must start with the "percentile_" prefix and end with an
-            int or float representing the percentile to compute (e.g.
+            or must start with the ``percentile_`` prefix and end with
+            an int or float representing the percentile to compute (e.g.
             ``percentile_10.5``). If only one statistic is to be
             computed, you can provide it directly as a string.
             Otherwise, provide a list of statistic names or a string