Restructure docs and change theme to ReadTheDocs

Signed-off-by: Joe Moorhouse <[email protected]>
os-climate · Sep 29, 2024 · 481db5a · 481db5a
1 parent 7fad273
commit 481db5a
Show file tree

Hide file tree

Showing 30 changed files with 646 additions and 530 deletions.
diff --git a/docs/conf.py b/docs/conf.py
@@ -13,9 +13,9 @@
 # -- Project information -----------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
 
-project = "PhysicalRisk"
-copyright = "2024, DCV"
-author = "DCV"
+project = "physrisk"
+copyright = "2024, OS-Climate"
+author = "OS-Climate"
 
 # The full version, including alpha/beta/rc tags
 # release = "1.1.0"
@@ -70,19 +70,23 @@
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
 
 html_logo = "images/OS-Climate-Logo.png"
-html_theme = "pydata_sphinx_theme"
+html_theme = "sphinx_rtd_theme"
+#html_theme = "pydata_sphinx_theme"
 html_static_path = ["_static"]
 
 # Don't show the code
 html_show_sourcelink = True
 
 html_theme_options = {
-    # 'logo_only': False,
+    "logo_only": False,
     # 'display_version': False,
     # Table of contents options
     "collapse_navigation": False,
+    "style_nav_header_background": "#d2d2d2"
+    # "#e3e3e3",
 }
 
+
 html_sidebars = {
     "**": [
         "globaltoc.html",  # Índice general

diff --git a/docs/conf.py.backup b/docs/conf.py.backup
diff --git a/docs/getting-started.rst b/docs/getting-started.rst
diff --git a/docs/examples/asset_level_impacts.ipynb → ...getting_started/asset_level_impacts.ipynb b/docs/examples/asset_level_impacts.ipynb → ...getting_started/asset_level_impacts.ipynb
diff --git a/docs/getting_started/getting_started.rst b/docs/getting_started/getting_started.rst
@@ -0,0 +1,11 @@
+Getting started
+===============
+
+The following examples provide a walk-through of phyrisk's functionality, starting with access to hazard indicator data and presenting the hazard inventory then moving onto the running of asset level calculations.
+
+.. toctree::
+   :maxdepth: 2
+
+   hazard_indicators
+   hazard_inventory
+   asset_level_impacts
diff --git a/docs/examples/hazard_indicators.ipynb → docs/getting_started/hazard_indicators.ipynb b/docs/examples/hazard_indicators.ipynb → docs/getting_started/hazard_indicators.ipynb