268 docs gtfs tutorial (#284)

* chore: Ignore quarto lint * chore: Add diff in gtfs.qmd before context switch to PR * chore: Adjust file locations to integrate with new site structure * feat: Set up GTFS page as a listing * docs: Fix small typo * fix: Update listings to ensure individual articles aren't listed along with sub-indexes * style: Add scrolling tag to table printouts * feat: Task to ingest data * feat: Task to examine attributes of MultiGtfsInstance * feat: Check validity task * feat: Task to visualise stop locations * feat: Cropping intro * feat: Filter to bbox explanation * feat: Explain date restriction method with date ranges * feat: Create calendar from calendar-dates task * feat: Final task & conclusion * fix: Minor typos * refactor: Move downloads to tmp for tutorial * chore: Rename tutorial filenm according to latest title * chore: Remove kernelspec from YAML * fix: Remove unused imports * fix: Rm reference to here in hint code block * chore: changed bus GTFS source to improve BBOX coverage * chore: added docs wide css file; changed from tutorial specific file * chore: moved GTFS tutorial to be accessible from main listing * style: Adjusting line lengths * feat: Add tabular summary task * feat: added trip count timeseries visual * chore: swapped help() for links to API docs * refactor: Remove help chunk for GtfsInstance and replace links with ones that open externally * refactor: Small typo * chore: removed unnecessary css file * fix: ordering with how to pages * fix: removed reference to jupyter kernel in yaml --------- Co-authored-by: Ethan Moss <[email protected]>
datasciencecampus · Jun 4, 2024 · 184fd5e · 184fd5e
1 parent 8f3e4bd
commit 184fd5e
Show file tree

Hide file tree

Showing 12 changed files with 644 additions and 12 deletions.
diff --git a/.gitignore b/.gitignore
@@ -1,3 +1,6 @@
+docs/tutorials/*_files/
+docs/tutorials/outputs/
+
 # transport modelling data formats
 **/*.pbf
 **/*.mapdb

diff --git a/_quarto.yml b/_quarto.yml
@@ -55,7 +55,9 @@ website:
       - section: How-To
         href: docs/how_to/index.qmd
         contents:
-          - auto: "docs/how_to/**/*.qmd"
+          - "docs/how_to/uc_pop/index.qmd"
+          - "docs/how_to/gtfs/index.qmd"
+          - "docs/how_to/osm/index.qmd"
       - section: Tutorials
         href: docs/tutorials/index.qmd
         contents:
@@ -84,6 +86,7 @@ website:
 
 format:
   html:
+    css: docs/_static/styles.css
     mainfont: Arial
     theme:
       - flatly

diff --git a/docs/_static/styles.css b/docs/_static/styles.css
@@ -0,0 +1,4 @@
+.scrolling {
+    max-height: 500px;
+    overflow-y: auto;
+}
diff --git a/docs/explanation/index.qmd b/docs/explanation/index.qmd
@@ -3,7 +3,7 @@ title: Explanation
 listing:
     type: table
     contents:
-        - "/**/*.qmd"
+        - "/**/index.qmd"
     fields: [title, description, reading-time]
     sort: title
     sort-ui: true

diff --git a/docs/how_to/gtfs/index.qmd b/docs/how_to/gtfs/index.qmd
@@ -1,5 +1,5 @@
 ---
-title: "1. Get Public Transit Schedule Data (GTFS)"
+title: "2. Get Public Transit Schedule Data (GTFS)"
 description: Instructions on retrieving public transit schedule GTFS data.
 date-modified: 05/16/2024  # must be in MM/DD/YYYY format
 categories: ["How-To"]  # see https://diataxis.fr/tutorials-how-to/#tutorials-how-to, delete as appropriate

diff --git a/docs/how_to/index.qmd b/docs/how_to/index.qmd
@@ -3,7 +3,7 @@ title: How-To
 listing:
     type: table
     contents:
-        - "/**/*.qmd"
+        - "/**/index.qmd"
     fields: [title, description, reading-time]
     sort: title
     sort-ui: true

diff --git a/docs/how_to/osm/index.qmd b/docs/how_to/osm/index.qmd
@@ -1,5 +1,5 @@
 ---
-title: "2. Get OpenStreetMap Data"
+title: "3. Get OpenStreetMap Data"
 description: Instructions on retrieving OpenStreetMap data.
 date-modified: 05/16/2024  # must be in MM/DD/YYYY format
 categories: ["How-To"]  # see https://diataxis.fr/tutorials-how-to/#tutorials-how-to, delete as appropriate

diff --git a/docs/how_to/uc_pop/index.qmd b/docs/how_to/uc_pop/index.qmd
@@ -1,5 +1,5 @@
 ---
-title: "3. Get Gridded Population Estimates"
+title: "1. Get Gridded Population Estimates"
 description: Instructions on retrieving gridded population estimates for calculating urban centres and population distributions.
 date-modified: 05/16/2024  # must be in MM/DD/YYYY format
 categories: ["How-To"]  # see https://diataxis.fr/tutorials-how-to/#tutorials-how-to, delete as appropriate