Skip to content

Commit ebe4c6f

Browse files
committed
Fix links and try collapsible in TOML
1 parent aa76185 commit ebe4c6f

4 files changed

Lines changed: 8 additions & 9 deletions

File tree

docs/examples/input_format.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ The table below summarises the main groups of input files:
7171
??? info "Strategic pipeline data files description"
7272

7373
**Note:** The structure below follows the order defined in `strategic_pipeline.toml`.
74-
For reference, see the [TOML examples](toml_examples.md).
74+
For reference, see the [TOML examples](toml_examples.md#1-strategic-pipeline).
7575

7676
### A. Demand Data
7777

@@ -251,7 +251,7 @@ The table below summarises the main groups of input files:
251251
| max_dist | Max distance | 150 |
252252
| time | Heuristic time (minutes) | 25 |
253253

254-
See [Heuristics Computation Inputs](#heuristics-computation-inputs) for more details.
254+
See [Heuristics Computation Inputs](#3-heuristics-computation-inputs) for more details.
255255

256256
---
257257

@@ -271,7 +271,7 @@ The Heuristics are computed to support the path finding algorithm (A*). These ca
271271
performed as a uniform cost search (UCS).
272272

273273
This subset is sufficient to **compute travel-time heuristics** for the pathfinder. See
274-
[heuristics_computation.toml](toml_examples.md) for example of TOML
274+
[heuristics_computation.toml](toml_examples.md#3-heuristics-computation) for example of TOML
275275
file configuring the [compute_air_rail_heuristics.py](https://github.com/UoW-ATM/MultiModX/blob/main/script/strategic/compute_air_rail_heuristics.py) script that is the one used to generate the heuristics.
276276

277277

docs/examples/toml_examples.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,11 +16,10 @@ here a description of the different elements of the configuration files is prov
1616
## 1. Strategic Pipeline
1717

1818

19-
::: info "Strategic pipeline TOML description"
19+
??? info "Strategic pipeline TOML description"
2020
```toml
21-
{{ read_file("examples/toml/strategic_pipeline.toml") }}
21+
{{ read_file("examples/toml/strategic_pipeline.toml") | indent(4) }}
2222
```
23-
:::
2423

2524
---
2625
## 2. Policy Package

docs/pre-tactical/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ Specify:
2222
- Output folder structure
2323
- Replanning constraints, to control which itineraries are valid as alternatives, and optimisation objectives, to select how to assign passengers to alternatives.
2424

25-
See [TOML](../examples/toml_examples.md#pretactical-pipeline) for examples and description.
25+
See [TOML](../examples/toml_examples.md#4-pretactical-pipeline) for examples and description.
2626

2727
### 2. Run the replanning script
2828

docs/strategic/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ python strategic_pipeline.py -tf ../../data/CS_example/v=0.1/CS_example.PP00.tom
5959

6060
The strategic pipeline is fully **configuration-driven** via [TOML files](../examples/toml_examples.md), primarily:
6161

62-
- [`strategic_pipeline.toml`](../examples/toml_examples.md#strategic-pipeline)
62+
- [`strategic_pipeline.toml`](../examples/toml_examples.md#1-strategic-pipeline)
6363
- [`policy_package.toml`](../examples/toml_examples.md#2-policy-package)
6464

6565
At a high level, the configuration is organised as follows:
@@ -275,7 +275,7 @@ of the schedules (e.g. due to an optimisation (as performed by the Multimodal Sc
275275

276276
See high-level description of all the CSV input files in
277277
[Input Files Strategic Pipeline](../examples/input_format.md#2-strategic-pipeline-inputs) for the strategic
278-
pipeline and [TOML - Policy Package](../examples/toml_examples.md#policy-package) for the definition of the Policy Package in the
278+
pipeline and [TOML - Policy Package](../examples/toml_examples.md#2-policy-package) for the definition of the Policy Package in the
279279
associated TOML config file.
280280

281281
#### 3. Compute Potential Paths Stage

0 commit comments

Comments
 (0)