From 35522f7c74ea817a21d53d6c1a6832845b929af5 Mon Sep 17 00:00:00 2001 From: elbeejay Date: Mon, 4 Mar 2024 19:59:12 -0500 Subject: [PATCH] move api docs pages --- docs/_config.yml | 39 ++++++++++++++++++++++++++++ docs/_toc.yml | 53 ++++++++++++++++++++++++++++++++++++++ docs/{ => api}/index.rst | 0 docs/{ => api}/modules.rst | 0 docs/{ => api}/setup.rst | 0 5 files changed, 92 insertions(+) create mode 100755 docs/_config.yml create mode 100755 docs/_toc.yml rename docs/{ => api}/index.rst (100%) rename docs/{ => api}/modules.rst (100%) rename docs/{ => api}/setup.rst (100%) diff --git a/docs/_config.yml b/docs/_config.yml new file mode 100755 index 0000000..5d65b8b --- /dev/null +++ b/docs/_config.yml @@ -0,0 +1,39 @@ +# Book settings +# Learn more at https://jupyterbook.org/customize/config.html + +title: GOST Urbanization +author: Benjamin P. Stewart +logo: images/logo.png + +# Force re-execution of notebooks on each build. +# See https://jupyterbook.org/content/execute.html +execute: + execute_notebooks: force + allow_errors: true + +# only build files in toc +only_build_toc: true + +# Add a bibtex file so that we can create citations +bibtex_bibfiles: + - references.bib + +# Information about where the book exists on the web +repository: + url: https://github.com/worldbank/GOST_Urban # Online location of your book + path_to_book: docs # Optional path to your book, relative to the repository root + branch: main # Which branch of the repository should be used when creating links (optional) + +# Add GitHub buttons to your book +# See https://jupyterbook.org/customize/config.html#add-a-link-to-your-repository +html: + use_issues_button: false + use_repository_button: true + +# specify sphinx extensions +sphinx: + extra_extensions: + - sphinx.ext.napoleon + - sphinxcontrib.apidoc + config: + apidoc_module_dir: ../src diff --git a/docs/_toc.yml b/docs/_toc.yml new file mode 100755 index 0000000..cf94258 --- /dev/null +++ b/docs/_toc.yml @@ -0,0 +1,53 @@ +# Table of contents +# Learn more at https://jupyterbook.org/customize/toc.html + +format: jb-book +root: README +parts: + - caption: Documentation + chapters: + - file: api/GOSTurban.rst + - caption: Novel Urbanization + chapters: + - file: novel_context + - file: urbanization_comparison + - caption: Tutorials + chapters: + - file: notebooks/Tutorials/UrbanAreas_tutorials.ipynb + - file: notebooks/Tutorials/LEI_Example.ipynb + # - caption: Implementations + # chapters: + # - file: notebooks/Implementations/JUP_SURGP_GLO_B_D__LEI_Evaluation.ipynb + # - file: notebooks/Implementations/URB_DECAT_B_ExploringGHSSMODcode.ipynb + # - file: notebooks/Implementations/URB_SEAU1_B_A_Ka_ExtractDataUrban.ipynb + # - file: notebooks/Implementations/WSF_DECAT_B_ExploringIDCerrors.ipynb + # - caption: KAZ_SCADR_UrbanizationReview + # chapters: + # - file: notebooks/Implementations/KAZ_SCADR_UrbanizationReview/ECA_Urban_Extents.ipynb + # - file: notebooks/Implementations/KAZ_SCADR_UrbanizationReview/Urban_metrics_Combine_All.ipynb + # - file: notebooks/Implementations/KAZ_SCADR_UrbanizationReview/Urban_metrics_Shape.ipynb + # - file: notebooks/Implementations/KAZ_SCADR_UrbanizationReview/Urban_metrics_Structure.ipynb + # - file: notebooks/Implementations/KAZ_SCADR_UrbanizationReview/KAZ_Urbanization_Review.ipynb + # - file: notebooks/Implementations/KAZ_SCADR_UrbanizationReview/Urban_metrics_Fullness.ipynb + # - file: notebooks/Implementations/KAZ_SCADR_UrbanizationReview/Urban_metrics_Sprawl.ipynb + # - caption: POV_EEAPV_COG_urban_assessment + # chapters: + # - file: notebooks/Implementations/POV_EEAPV_COG_urban_assessment/Summarize_Urban.ipynb + # - caption: Slum_Mapping + # chapters: + # - file: notebooks/Implementations/Slum_Mapping/Imagery_Search.ipynb + # - caption: URB_SCAUR_UKR_B_I_urbanizationReview + # chapters: + # - file: notebooks/Implementations/URB_SCAUR_UKR_B_I_urbanizationReview/URB_SCAUR_UKR_B_I_urbanizationReview.ipynb + # - caption: URB_SEAU1_NovelUrbanization + # chapters: + # - file: notebooks/Implementations/URB_SEAU1_NovelUrbanization/Create_Mosaick_Datasets.ipynb + # - file: notebooks/Implementations/URB_SEAU1_NovelUrbanization/GHSL_Standardize_To_Country.ipynb + # - file: notebooks/Implementations/URB_SEAU1_NovelUrbanization/MAP_Urbanization.ipynb + # - file: notebooks/Implementations/URB_SEAU1_NovelUrbanization/NGA_specific_results.ipynb + # - file: notebooks/Implementations/URB_SEAU1_NovelUrbanization/URB_SEAU1_B_A_Ka_NovelUrbanizaton.ipynb + # - file: notebooks/Implementations/URB_SEAU1_NovelUrbanization/WBGAPI_Extract_urbanization_GDP.ipynb + # - caption: URB_SURDR_ZAF_Energy_Transition + # chapters: + # - file: notebooks/Implementations/URB_SURDR_ZAF_Energy_Transition/Data Preparation.ipynb + # - file: notebooks/Implementations/URB_SURDR_ZAF_Energy_Transition/Zonal_statistics.ipynb diff --git a/docs/index.rst b/docs/api/index.rst similarity index 100% rename from docs/index.rst rename to docs/api/index.rst diff --git a/docs/modules.rst b/docs/api/modules.rst similarity index 100% rename from docs/modules.rst rename to docs/api/modules.rst diff --git a/docs/setup.rst b/docs/api/setup.rst similarity index 100% rename from docs/setup.rst rename to docs/api/setup.rst