adding toc, cleaning up (#22)

datapartnership · Mar 17, 2024 · 8cccaec · 8cccaec
1 parent b405eb9
commit 8cccaec
Show file tree

Hide file tree

Showing 11 changed files with 231 additions and 85 deletions.
diff --git a/.gitignore b/.gitignore
@@ -93,3 +93,4 @@ _build/
 
 /data
 
+/documents
diff --git a/Makefile b/Makefile
@@ -0,0 +1,8 @@
+
+all: build serve
+
+build:
+	jupyter-book build . --config docs/_config.yml --toc docs/_toc.yml
+
+serve:
+	open _build/html/index.html
diff --git a/docs/_config.yml b/docs/_config.yml
@@ -8,35 +8,33 @@ repository:
   url: https://github.com/datapartnership/heatwaves
   branch: main
 
-#######################################################################################
-# HTML-specific settings
 html:
 
-    home_page_in_navbar: false
-    extra_navbar: ""
-    use_edit_page_button: true
-    use_repository_button: true
-    use_issues_button: true
-    baseurl: https://datapartnership.github.io/datapartnership/heatwaves/philippines
-    extra_footer: |
-        <div>
-            <b>All content (unless otherwise specified) is subject to the <a href="https://raw.githubusercontent.com/worldbank/template/main/LICENSE">World Bank Master Community License Agreement.</a></b>
-        </div>
-    google_analytics_id: G-ETJ4QT0E4L
-=======
-#   home_page_in_navbar: true
-#   extra_navbar: ""
-#   use_edit_page_button: true
-#   use_repository_button: true
-#   use_issues_button: true
-#   baseurl: https://datapartnership.github.io/heatwaves/PH
-#   extra_footer: |
-#     <div>
-#      Country borders or names do not necessarily reflect the World Bank Group’s official position. All maps are for illustrative purposes and do not imply the expression of any opinion on the part of the World Bank, concerning the legal status of any country or territory or concerning the delimitation of frontiers or boundaries
-#     </div>
-#     <div>
-#         <b>All content (unless otherwise specified) is subject to the <a href="https://www.mozilla.org/en-US/MPL">Mozilla Public License.</a></b>
-#     </div>
+    # home_page_in_navbar: false
+    # extra_navbar: ""
+    # use_edit_page_button: true
+    # use_repository_button: true
+    # use_issues_button: true
+    # baseurl: https://datapartnership.github.io/datapartnership/heatwaves/philippines
+    # extra_footer: |
+    #     <div>
+    #         <b>All content (unless otherwise specified) is subject to the <a href="https://raw.githubusercontent.com/worldbank/template/main/LICENSE">World Bank Master Community License Agreement.</a></b>
+    #     </div>
+    # google_analytics_id: G-ETJ4QT0E4L
+
+  home_page_in_navbar: true
+  extra_navbar: ""
+  use_edit_page_button: true
+  use_repository_button: true
+  use_issues_button: true
+  baseurl: https://datapartnership.github.io/heatwaves/PH
+  extra_footer: |
+    <div>
+     Country borders or names do not necessarily reflect the World Bank Group’s official position. All maps are for illustrative purposes and do not imply the expression of any opinion on the part of the World Bank, concerning the legal status of any country or territory or concerning the delimitation of frontiers or boundaries
+    </div>
+    <div>
+        <b>All content (unless otherwise specified) is subject to the <a href="https://www.mozilla.org/en-US/MPL">Mozilla Public License.</a></b>
+    </div>
 
 
 #######################################################################################

diff --git a/docs/_toc.yml b/docs/_toc.yml
@@ -9,11 +9,3 @@ parts:
       - file: notebooks/measuring-heatwaves/heatwaves-in-philippines.ipynb
       - file: notebooks/socio-economic-indicators/census.ipynb
       - file: notebooks/air-pollution/air-pollution.ipynb
-      # - url: https://wbdatalab.org
-      #   title: World Bank Data Lab
-      # - url: https://www.worldbank.org/en/about/unit/unit-dec
-      #   title: World Bank DEC
-      # - url: https://www.worldbank.org/en/research/dime
-      #   title: World Bank DIME
-# =======
-# root: notebooks/measuring-heatwaves/heatwaves-in-philippines.ipynb
diff --git a/docs/foundational_datasets_and_data_products.md b/docs/foundational_datasets_and_data_products.md
@@ -0,0 +1,19 @@
+# Foundational Datasets, Data Products, & Sample Indicators
+
+## Foundational Datasets
+
+**Foundational Datasets** refer to **all** datasets used in the analytics prepared for a project. The Foundational Datasets table includes a description of the data and their update frequency, as well as access links and contact information for questions about use and access. Users should not require any datasets not included in this table to complete the analytical work for the Data Good.
+
+Following is list of all Foundational Datasets used in this Data Good:
+
+| ID  | Indicator                                | Description |
+| --- | ---------------------------------------- | ----------- |
+| 1   | # of Heatwave days in the last 50 years  |             |
+| 2   | CLUPs for all the cities in Manila       |             |
+| 3   | # People who are vulnerable              |             |
+| 4   | # NO2 levels in all the city             |             |
+| 5   | # O3 levels in all the cities            |             |
+| 6   | % Green space in each city within Manila |             |
+| 7   | Points of Interest from OSM              |             |
+
+
diff --git a/docs/~$DRR Grant proposal - Excess Heat in Filipino Cities.docx b/docs/~$DRR Grant proposal - Excess Heat in Filipino Cities.docx
diff --git a/docs/~WRL1187.tmp b/docs/~WRL1187.tmp
diff --git a/images/heatindex_pasay.png b/images/heatindex_pasay.png
diff --git a/images/heatindex_tomorrowio.png b/images/heatindex_tomorrowio.png
diff --git a/notebooks/air-pollution/air-pollution.ipynb b/notebooks/air-pollution/air-pollution.ipynb
diff --git a/notebooks/heat-and-air-pollution.ipynb b/notebooks/heat-and-air-pollution.ipynb