Merge pull request #87 from worldbank/pages_update

Pages update
worldbank · Nov 11, 2024 · b98f10f · b98f10f
2 parents a1df6f3 + a5a194a
commit b98f10f
Show file tree

Hide file tree

Showing 5 changed files with 38 additions and 12 deletions.
diff --git a/docs/_config.yml b/docs/_config.yml
@@ -35,3 +35,8 @@ sphinx:
   config:
     html_show_copyright: false
     html_last_updated_fmt: "%b %d, %Y"
+    apidoc_module_dir: ../space2stats_api/src
+  extra_extensions:
+  - 'sphinx.ext.autodoc'
+  - sphinx.ext.napoleon
+  - sphinxcontrib.apidoc
diff --git a/docs/_toc.yml b/docs/_toc.yml
@@ -1,21 +1,26 @@
 format: jb-book
-root: README
+root: docs/readme.md
 
 parts:
   - caption: Concept Note
     numbered: False
     chapters:
-      - file: docs/Introduction.md    
-  - caption: Example summaries
+      - file: docs/Introduction.md
+      - file: docs/annexA.md    
+  - caption: S2S Sub-tasks
     numbered: False
     chapters:
-        - file: notebooks/Space2Stats_Comparing_H3_WBAdmin.ipynb
-        - file: notebooks/Space2Stats_RunZonal.ipynb
-        - file: notebooks/Space2Stats_RunZonal_HTI.ipynb
-  - caption: Food Security
+        - file: docs/sub_tasks/admin_bounds.md
+        - file: docs/sub_tasks/sub_national_poverty.md
+        - file: docs/sub_tasks/geest.md
+        - file: docs/sub_tasks/geo_enhancement.md
+  - caption: S2S Examples
     numbered: False
     chapters:
-        - file: notebooks/h3-food-security.ipynb
-  - caption: Additional Resources
+        - file: notebooks/user-docs/space2stats_py_package_demo.ipynb
+        - file: notebooks/user-docs/space2stats_api_demo.ipynb
+        - file: notebooks/user-docs/space2stats_api_demo_R.Rmd
+  - caption: S2S Python Documentation
+    numbered: False
     chapters:
-      - file: docs/annexA.md
+        - file: docs/api.rst
diff --git a/docs/annexA.md b/docs/annexA.md
@@ -1,4 +1,4 @@
-# Annex A: Datasets to be Summarized
+# Annex A: S2S Datasets
 |Phase|Category|Variable Name|Source|
 |:----|:----|:----|:----|
 |1|Access|Distance to airport  |Global Friction Surface 2019|

diff --git a/notebooks/user-docs/space2stats_api_demo.ipynb b/notebooks/user-docs/space2stats_api_demo.ipynb
@@ -1,5 +1,14 @@
 {
  "cells": [
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "# Access S2S api directly\n",
+    "\n",
+    "This notebook walks through an example of sending an API call directly without using the space2stats python library"
+   ]
+  },
   {
    "cell_type": "code",
    "execution_count": 1,

diff --git a/notebooks/user-docs/space2stats_py_package_demo.ipynb b/notebooks/user-docs/space2stats_py_package_demo.ipynb
@@ -1,5 +1,12 @@
 {
  "cells": [
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "# Access S2S via Python Library"
+   ]
+  },
   {
    "cell_type": "code",
    "execution_count": 39,
@@ -33,7 +40,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "#### Expected environment variables to be set\n",
+    "__Expected environment variables to be set__ from dotenv file\n",
     "\n",
     "\n",
     "```.env\n",