Skip to content

Commit

Permalink
Update Documentation (#58)
Browse files Browse the repository at this point in the history
* Rename data

* Touch up
  • Loading branch information
g4brielvs authored Jan 29, 2024
1 parent 56fe41b commit 260c8e4
Show file tree
Hide file tree
Showing 5 changed files with 59 additions and 14 deletions.
48 changes: 48 additions & 0 deletions _static/custom.css
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
root {
--sd-color-primary: #3eacad;
--sd-color-primary-highlight: #df6b00;
--sd-color-secondary: #56c3c4;
--sd-color-secondary-highlight: #f7951d;
}

iframe {
display: block;
border-style: none;
margin: 0 auto;
}

a:hover {
color: #56c3c4;
}

a:visited {
color: #310459;
}

a.headerlink {
color: #3eacad;
}

a.reference.external:hover {
color: #f7951d;
}

a.reference.internal:hover {
color: #3eacad;
}

a.current.reference.internal {
color: #56c3c4;
}

.prev-next-area a p.prev-next-title:hover {
color: #3eacad;
}

.prev-next-area a:visited p.prev-next-title:hover {
color: #56c3c4;
}

#pst-back-to-top {
background-color: #3eacad;
}
4 changes: 2 additions & 2 deletions docs/_config.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Book settings
title:
author: World Bank Development Data Group
author: Development Data Group
logo: docs/images/logo.png
exclude_patterns: [_build, Thumbs.db, .DS_Store, "**.ipynb_checkpoints"]
only_build_toc_files: true
Expand All @@ -18,7 +18,7 @@ html:
baseurl: https://datapartnership.github.io/datapartnership/syria-economic-monitor
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
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>
Expand Down
5 changes: 2 additions & 3 deletions docs/_toc.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,10 @@ parts:
- caption: Introduction to Data Goods
chapters:
- file: docs/introduction_to_data_goods
- file: docs/foundational_datasets_and_data_products
sections:
- file: notebooks/earthquake-intensity/earthquake_intensity.ipynb
- file: docs/data
- caption: Data Products
chapters:
- file: notebooks/earthquake-intensity/earthquake_intensity.ipynb
- file: notebooks/ntl-analysis/README
sections:
- file: notebooks/ntl-analysis/ntl-update-6-2023.md
Expand Down
14 changes: 6 additions & 8 deletions ...oundational_datasets_and_data_products.md → docs/data.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,17 @@
# Foundational Datasets, Data Products, & Sample Indicators
# Datasets, Data Products, & Sample Indicators

## Foundational Datasets
## 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.
**Datasets** refer to **all** datasets used in the analytics prepared for a project. The **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:
The following is the list of all Datasets used in this Data Good:

```{note}
**Project Sharepoint** links are only accessible to the project team. For permissions to access these data, please write to the contact provided.
**Project Sharepoint** links are only accessible to the project team. For permissions to access these data, please write to the contact provided.
The **Development Data Hub** is the World Bank's central data catalogue and includes meta-data and license information.
The **Development Data Hub** is the World Bank's central data catalogue and includes meta-data and license information.Where feasible, all datasets that can be obtained through the Development Data Hub have been placed in a special collection: [Syria Economic Monitor Data Collection](https://datacatalog.worldbank.org/int/search/collections/sem).
```

Where feasible, all datasets that can be obtained through the Development Data Hub have been placed in a special collection: [Syria Economic Monitor Data Collection](https://datacatalog.worldbank.org/int/search/collections/sem).

```{table}
:name: foundational_datasets
Expand Down
2 changes: 1 addition & 1 deletion docs/requirements.txt
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
docutils==0.17.1
jupyter-book==0.15.1
jupyter-book==1.0.0

0 comments on commit 260c8e4

Please sign in to comment.