Merge branch 'docs' of github.com:MIGG-NTU/PyTomoATT into docs

TomoATT · Jul 12, 2024 · d3dd40e · d3dd40e
2 parents f6dad36 + 6d2a433
commit d3dd40e
Show file tree

Hide file tree

Showing 8 changed files with 58 additions and 23 deletions.
diff --git a/.github/workflows/build-docs.yml b/.github/workflows/build-docs.yml
@@ -6,10 +6,11 @@ name: Build documentations
 on:
   push:
     branches: [ "docs" ]
-  pull_request:
-    branches: [ "main" ]
-
-
+  workflow_call:
+    inputs:
+      config-path:
+        required: true
+        type: string
 jobs:
   deploy:
     runs-on: ubuntu-latest
@@ -47,4 +48,4 @@ jobs:
           # Only keep the latest commit to avoid bloating the repository
           force_orphan: true
           user_name: 'github-actions[bot]'
-          user_email: 'github-actions[bot]@users.noreply.github.com'
+          user_email: 'github-actions[bot]@users.noreply.github.com'
diff --git a/source/conf.py b/source/conf.py
@@ -11,7 +11,7 @@
 project = 'PyTomoATT'
 copyright = '2023, Mijian Xu'
 author = 'Mijian Xu'
-release = '0.1.4'
+release = '0.1.8'
 
 # -- General configuration ---------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
@@ -26,9 +26,6 @@
               "sphinx.ext.mathjax",
               "sphinx.ext.todo",
               "sphinx.ext.viewcode",
-            #   "sphinxcontrib.icon",
-            #   "sphinx_gallery.gen_gallery",
-            #   'sphinxcontrib.bibtex',
 ]
 
 
@@ -79,7 +76,8 @@
 copybutton_remove_prompts = True
 
 
-jupyter_execute_notebooks = "cache"
+# jupyter_execute_notebooks = "cache"
+nb_execution_mode = "cache"
 html_extra_path = []
 html_title = project
 html_css_files = ["custom.css"]

diff --git a/source/modules/src_rec/pytomoatt.src_rec.SrcRec.copy.rst b/source/modules/src_rec/pytomoatt.src_rec.SrcRec.copy.rst
@@ -0,0 +1,6 @@
+pytomoatt.src\_rec.SrcRec.copy
+==============================
+
+.. currentmodule:: pytomoatt.src_rec
+
+.. automethod:: SrcRec.copy
diff --git a/source/modules/src_rec/pytomoatt.src_rec.SrcRec.remove_specified_recs.rst b/source/modules/src_rec/pytomoatt.src_rec.SrcRec.remove_specified_recs.rst
@@ -0,0 +1,6 @@
+pytomoatt.src\_rec.SrcRec.remove\_specified\_recs
+=================================================
+
+.. currentmodule:: pytomoatt.src_rec
+
+.. automethod:: SrcRec.remove_specified_recs
diff --git a/source/modules/src_rec/pytomoatt.src_rec.SrcRec.select_by_datetime.rst b/source/modules/src_rec/pytomoatt.src_rec.SrcRec.select_by_datetime.rst
@@ -0,0 +1,6 @@
+pytomoatt.src\_rec.SrcRec.select\_by\_datetime
+==============================================
+
+.. currentmodule:: pytomoatt.src_rec
+
+.. automethod:: SrcRec.select_by_datetime
diff --git a/source/modules/src_rec/pytomoatt.src_rec.SrcRec.select_depth.rst b/source/modules/src_rec/pytomoatt.src_rec.SrcRec.select_depth.rst
@@ -0,0 +1,6 @@
+pytomoatt.src\_rec.SrcRec.select\_depth
+=======================================
+
+.. currentmodule:: pytomoatt.src_rec
+
+.. automethod:: SrcRec.select_depth
diff --git a/source/modules/src_rec/pytomoatt.src_rec.SrcRec.update.rst b/source/modules/src_rec/pytomoatt.src_rec.SrcRec.update.rst
@@ -0,0 +1,6 @@
+pytomoatt.src\_rec.SrcRec.update
+================================
+
+.. currentmodule:: pytomoatt.src_rec
+
+.. automethod:: SrcRec.update
diff --git a/source/modules/src_rec/src_rec.rst b/source/modules/src_rec/src_rec.rst
@@ -22,25 +22,31 @@ pytomoatt.src_rec
   :toctree: .
   :nosignatures:
 
-  ~SrcRec.read
-  ~SrcRec.write
+  ~SrcRec.add_noise
   ~SrcRec.append
+  ~SrcRec.calc_distance
+  ~SrcRec.copy
+  ~SrcRec.count_events_per_station
+  ~SrcRec.erase_duplicate_events
+  ~SrcRec.from_seispy
+  ~SrcRec.geo_weighting
   ~SrcRec.generate_double_difference
-  ~SrcRec.update
-  ~SrcRec.reset_index
+  ~SrcRec.plot
+  ~SrcRec.read
   ~SrcRec.remove_rec_by_new_src
+  ~SrcRec.remove_specified_recs
   ~SrcRec.remove_src_by_new_rec
-  ~SrcRec.update_num_rec
-  ~SrcRec.erase_duplicate_events
-  ~SrcRec.select_phase
+  ~SrcRec.reset_index
   ~SrcRec.select_box_region
-  ~SrcRec.calc_distance
+  ~SrcRec.select_by_datetime
+  ~SrcRec.select_depth
   ~SrcRec.select_distance
   ~SrcRec.select_one_event_in_each_subgrid
-  ~SrcRec.count_events_per_station
-  ~SrcRec.geo_weighting
-  ~SrcRec.add_noise
+  ~SrcRec.select_phase
+  ~SrcRec.update
+  ~SrcRec.update_num_rec
+  ~SrcRec.write
   ~SrcRec.write_receivers
   ~SrcRec.write_sources
-  ~SrcRec.from_seispy
-  ~SrcRec.plot
+
+