Add 3 new pages/sections to docs

docs/_config.yml

@@ -18,9 +18,9 @@ parse:
   # nb_number_source_lines: true
 
 # Define the name of the latex output file for PDF builds
-latex:
-  latex_documents:
-    targetname: book.tex
+# latex:
+#   latex_documents:
+#     targetname: book.tex
 
 # Add a bibtex file so that we can create citations
 # bibtex_bibfiles:
@@ -35,8 +35,10 @@ repository:
 # Add GitHub buttons to your book
 # See https://jupyterbook.org/customize/config.html#add-a-link-to-your-repository
 html:
+  home_page_in_navbar: false
   use_issues_button: true
   use_repository_button: true
+  use_edit_page_button: true
 
 sphinx:
   extra_extensions: [
@@ -50,3 +52,5 @@ sphinx:
   ]
   config:
     bibtex_reference_style: label
+
+exclude_patterns: [example_notebooks/*]

docs/_toc.yml

@@ -4,20 +4,17 @@
 format: jb-book
 root: index
 parts:
-# - file: markdown
 - caption: Documentation
   chapters:
+  - file: quick_start
   - file: classes-datastructures
-  - file: example_notebooks/workflow_minimal.ipynb
-  - file: input-files
-- caption: Notebooks
-  chapters:
-  - file: example_notebooks/echopro_workflow.ipynb
-  - file: example_notebooks/reports_workflow.ipynb
-  - file: example_notebooks/semi_variogram_workflow.ipynb
-  - file: example_notebooks/kriging_mesh_walkthrough.ipynb
-  - file: example_notebooks/transect_selection_workflow.ipynb
-  - file: example_notebooks/bootstrapping_walkthrough.ipynb
+  - file: input_files
+  - file: theory
+  - file: algo
+    title: Algorithmic implementation
+    sections:
+    - file: algo1
+    - file: algo2
 - caption: Help & reference
   chapters:
   - file: api

docs/algo.md

@@ -0,0 +1,3 @@
+# Algorithmic Implementations
+
+The following sections connect the underlying [theory](theory:theory_base) with the variables and data structures presented in [](data-structure).

docs/algo1.ipynb

@@ -0,0 +1,18 @@
+{
+ "cells": [
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "# Algo page1"
+   ]
+  }
+ ],
+ "metadata": {
+  "language_info": {
+   "name": "python"
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 2
+}

docs/algo2.ipynb

@@ -0,0 +1,18 @@
+{
+ "cells": [
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "# Algo page 2"
+   ]
+  }
+ ],
+ "metadata": {
+  "language_info": {
+   "name": "python"
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 2
+}

docs/classes-datastructures.md

@@ -1,3 +1,4 @@
+(data-structure)=
 # Classes and data structures
 
 ## Classes

docs/index.md

@@ -1,4 +1,4 @@
-# EchoPro documentation and example notebooks
+# EchoPro
 
 This site currently hosts example Jupyter notebooks for the new Python EchoPro package (https://github.com/uw-echospace/EchoPro/). Over time, the documentation for this package will be added here too.
 

docs/quick_start.ipynb

@@ -0,0 +1,18 @@
+{
+ "cells": [
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "# Quick start"
+   ]
+  }
+ ],
+ "metadata": {
+  "language_info": {
+   "name": "python"
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 2
+}

docs/theory.ipynb

@@ -0,0 +1,33 @@
+{
+ "cells": [
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "(theory:theory_base)=\n",
+    "# Theory"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": []
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": []
+  }
+ ],
+ "metadata": {
+  "language_info": {
+   "name": "python"
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 2
+}