diff --git a/_quarto.yml b/_quarto.yml index 34890d53..f37bb5b2 100644 --- a/_quarto.yml +++ b/_quarto.yml @@ -59,9 +59,12 @@ website: - section: Tutorials href: docs/tutorials/index.qmd contents: - - section: GTFS - contents: - - auto: "docs/tutorials/gtfs/*.qmd" + - "docs/tutorials/urban_centre/index.qmd" + - "docs/tutorials/population/index.qmd" + - "docs/tutorials/gtfs/index.qmd" + - "docs/tutorials/osm/index.qmd" + - "docs/tutorials/analyse_network/index.qmd" + - "docs/tutorials/metrics/index.qmd" - section: API Reference href: docs/reference/index.qmd contents: @@ -76,7 +79,7 @@ website: except where otherwise stated. right: > - Data Science Campus logo + Data Science Campus logo format: diff --git a/docs/tutorials/analyse_network/index.qmd b/docs/tutorials/analyse_network/index.qmd new file mode 100644 index 00000000..8ed36bb4 --- /dev/null +++ b/docs/tutorials/analyse_network/index.qmd @@ -0,0 +1,10 @@ +--- +title: "5. Analyse Network" +description: Learn how to use the `transport_performance.analyse_network` module through examples. +date-modified: 05/17/2024 # must be in MM/DD/YYYY format +categories: ["Tutorial"] # see https://diataxis.fr/tutorials-how-to/#tutorials-how-to, delete as appropriate +toc: true +date-format: iso +--- + +🚧 Page under construction 🚧 diff --git a/docs/tutorials/gtfs/a_tutorial.qmd b/docs/tutorials/gtfs/a_tutorial.qmd deleted file mode 100644 index e867d859..00000000 --- a/docs/tutorials/gtfs/a_tutorial.qmd +++ /dev/null @@ -1,28 +0,0 @@ ---- -title: A quick run-through -description: How to use the package -format: html ---- - - -This is a quick run-through. - -Press `CMD+SHIFT+I` to add a python block: - -```{python} - -import subprocess - -World = ( - subprocess.run(['git','config','user.name'], - stdout=subprocess.PIPE, - ) - .stdout - .strip() - .decode() - ) - -print(f"Hello {World}.") -``` - -Head over to [Quarto](https://quarto.org/) for more. diff --git a/docs/tutorials/gtfs/index.qmd b/docs/tutorials/gtfs/index.qmd new file mode 100644 index 00000000..0838685b --- /dev/null +++ b/docs/tutorials/gtfs/index.qmd @@ -0,0 +1,10 @@ +--- +title: "3. GTFS" +description: Learn how to use the `transport_performance.gtfs` module through examples. +date-modified: 05/17/2024 # must be in MM/DD/YYYY format +categories: ["Tutorial"] # see https://diataxis.fr/tutorials-how-to/#tutorials-how-to, delete as appropriate +toc: true +date-format: iso +--- + +🚧 Page under construction 🚧 diff --git a/docs/tutorials/index.qmd b/docs/tutorials/index.qmd index a3bb948c..8c037879 100644 --- a/docs/tutorials/index.qmd +++ b/docs/tutorials/index.qmd @@ -5,7 +5,7 @@ listing: contents: - "/**/*.qmd" fields: [title, description, reading-time] - sort: title desc + sort: title sort-ui: true filter-ui: true --- diff --git a/docs/tutorials/metrics/index.qmd b/docs/tutorials/metrics/index.qmd new file mode 100644 index 00000000..af7f5cea --- /dev/null +++ b/docs/tutorials/metrics/index.qmd @@ -0,0 +1,10 @@ +--- +title: "6. Metrics" +description: Learn how to use the `transport_performance.metrics` module through examples. +date-modified: 05/17/2024 # must be in MM/DD/YYYY format +categories: ["Tutorial"] # see https://diataxis.fr/tutorials-how-to/#tutorials-how-to, delete as appropriate +toc: true +date-format: iso +--- + +🚧 Page under construction 🚧 diff --git a/docs/tutorials/osm/index.qmd b/docs/tutorials/osm/index.qmd new file mode 100644 index 00000000..0d32119c --- /dev/null +++ b/docs/tutorials/osm/index.qmd @@ -0,0 +1,10 @@ +--- +title: "4. OSM" +description: Learn how to use the `transport_performance.osm` module through examples. +date-modified: 05/17/2024 # must be in MM/DD/YYYY format +categories: ["Tutorial"] # see https://diataxis.fr/tutorials-how-to/#tutorials-how-to, delete as appropriate +toc: true +date-format: iso +--- + +🚧 Page under construction 🚧 diff --git a/docs/tutorials/population/index.qmd b/docs/tutorials/population/index.qmd new file mode 100644 index 00000000..50b7b78a --- /dev/null +++ b/docs/tutorials/population/index.qmd @@ -0,0 +1,10 @@ +--- +title: "2. Population" +description: Learn how to use the `transport_performance.population` module through examples. +date-modified: 05/17/2024 # must be in MM/DD/YYYY format +categories: ["Tutorial"] # see https://diataxis.fr/tutorials-how-to/#tutorials-how-to, delete as appropriate +toc: true +date-format: iso +--- + +🚧 Page under construction 🚧 diff --git a/docs/tutorials/urban_centre/index.qmd b/docs/tutorials/urban_centre/index.qmd new file mode 100644 index 00000000..361f7ff9 --- /dev/null +++ b/docs/tutorials/urban_centre/index.qmd @@ -0,0 +1,10 @@ +--- +title: "1. Urban Centre" +description: Learn how to use the `transport_performance.urban_centre` module through examples. +date-modified: 05/17/2024 # must be in MM/DD/YYYY format +categories: ["Tutorial"] # see https://diataxis.fr/tutorials-how-to/#tutorials-how-to, delete as appropriate +toc: true +date-format: iso +--- + +🚧 Page under construction 🚧