added blacken-docs for doc code formatting

.pre-commit-config.yaml

@@ -4,3 +4,9 @@ repos:
     hooks:
     - id: black
       language_version: python3.9
+-   repo: https://github.com/adamchainz/blacken-docs
+    rev: 1.16.0
+    hooks:
+    - id: blacken-docs
+      additional_dependencies:
+        - black==24.1.1

doc/extras.rst

@@ -122,9 +122,8 @@ Later this can e.g. be used as input for the analytics module:
 .. code-block:: python
 
     stops, requests = get_stops_and_requests(
-        events=read_events_json("events.jsonl"),
-        space=read_params_json("params.json")
-        )
+        events=read_events_json("events.jsonl"), space=read_params_json("params.json")
+    )
 
 .. automodule:: ridepy.extras.io
     :members:

doc/issues.rst

@@ -10,9 +10,7 @@ If you in fact have run into an unreported issue, please describe clearly which
 .. code:: markdown
 
     ```python
-
-    def my_broken_function(a: int, b:float):
+    def my_broken_function(a: int, b: float):
         result = do_stuff()
         return 42 + result
-
     ```

pyproject.toml

@@ -58,6 +58,7 @@ dev = [
     "twine",
     "build",
     "auditwheel",
+    "blacken-docs",
 ]
 
 doc = [

src/ridepy/cli.py

@@ -129,11 +129,16 @@ def analyze(
     respectively.
     """
 
+    tasks = {"stops", "requests", "vehicle_quantities"}
+    if compute_system_quantities:
+        tasks.add("system_quantities")
+
     system_quantities = []
     for simulation_id in simulation_ids:
         _, sys_quant = perform_single_analysis(
             sim_id=simulation_id,
             data_dir=output_directory,
+            tasks_if_existent=tasks,
         )
         system_quantities.append(sys_quant)
 

src/ridepy/extras/io.py

@@ -24,7 +24,7 @@ class ParamsJSONEncoder(json.JSONEncoder):
 
     .. code-block:: python
 
-        >>> json.dumps(params, cls=ParamsJSONEncoder)
+        json.dumps(params, cls=ParamsJSONEncoder)
 
     """
 
@@ -63,7 +63,7 @@ class ParamsJSONDecoder(json.JSONDecoder):
 
     .. code-block:: python
 
-        >>> json.loads(params, cls=ParamsJSONDecoder)
+       json.loads(params, cls=ParamsJSONDecoder)
 
     """
 
@@ -117,7 +117,7 @@ class EventsJSONEncoder(json.JSONEncoder):
 
     .. code-block:: python
 
-        >>> json.dumps(events, cls=EventsJSONEncoder)
+        json.dumps(events, cls=EventsJSONEncoder)
 
     """
 

src/ridepy/extras/simulation_set.py

@@ -425,10 +425,15 @@ def _two_level_dict_update(
 
         .. code-block:: python
 
-            >>> SimulationSet._two_level_dict_update(
-            ...     {"a": {"b": 5, 6: 8}}, {"a": {6: "fooo", 8: "baaar"}, "baz": {"6": 6}}
-            ... )
-            {'a': {'b': 5, 6: 'fooo', 8: 'baaar'}, 'baz': {'6': 6}}
+            SimulationSet._two_level_dict_update(
+                {"a": {"b": 5, 6: 8}}, {"a": {6: "fooo", 8: "baaar"}, "baz": {"6": 6}}
+            )
+
+        yields
+
+        .. code-block:: python
+
+            {"a": {"b": 5, 6: "fooo", 8: "baaar"}, "baz": {"6": 6}}
 
 
         Parameters

src/ridepy/util/dispatchers/__init__.py

@@ -51,8 +51,7 @@ def MyFancyDispatcher(
             stoplist: Stoplist,
             space: TransportSpace,
             seat_capacity: int,
-        ) -> SingleVehicleSolution:
-            ...
+        ) -> SingleVehicleSolution: ...
 
     """