From 354b60fc060bea7fdd7bfe98320cf02dcf9550d0 Mon Sep 17 00:00:00 2001 From: Mijian Xu Date: Wed, 13 Mar 2024 00:51:53 +0800 Subject: [PATCH 1/2] update docs --- .github/workflows/build-docs.yml | 11 ++++++----- source/conf.py | 3 --- 2 files changed, 6 insertions(+), 8 deletions(-) diff --git a/.github/workflows/build-docs.yml b/.github/workflows/build-docs.yml index 4098cd2..f29708a 100644 --- 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' \ No newline at end of file + user_email: 'github-actions[bot]@users.noreply.github.com' diff --git a/source/conf.py b/source/conf.py index 425646b..a8967b5 100644 --- a/source/conf.py +++ b/source/conf.py @@ -26,9 +26,6 @@ "sphinx.ext.mathjax", "sphinx.ext.todo", "sphinx.ext.viewcode", - # "sphinxcontrib.icon", - # "sphinx_gallery.gen_gallery", - # 'sphinxcontrib.bibtex', ] From 6d2a43334ac072ede8de2b7f389a0c4583c8bc3a Mon Sep 17 00:00:00 2001 From: Mijian Xu Date: Fri, 15 Mar 2024 02:58:27 +0800 Subject: [PATCH 2/2] update docs --- source/conf.py | 5 +-- .../src_rec/pytomoatt.src_rec.SrcRec.copy.rst | 6 ++++ ...t.src_rec.SrcRec.remove_specified_recs.rst | 6 ++++ ...oatt.src_rec.SrcRec.select_by_datetime.rst | 6 ++++ .../pytomoatt.src_rec.SrcRec.select_depth.rst | 6 ++++ .../pytomoatt.src_rec.SrcRec.update.rst | 6 ++++ source/modules/src_rec/src_rec.rst | 33 +++++++++++-------- 7 files changed, 53 insertions(+), 15 deletions(-) create mode 100644 source/modules/src_rec/pytomoatt.src_rec.SrcRec.copy.rst create mode 100644 source/modules/src_rec/pytomoatt.src_rec.SrcRec.remove_specified_recs.rst create mode 100644 source/modules/src_rec/pytomoatt.src_rec.SrcRec.select_by_datetime.rst create mode 100644 source/modules/src_rec/pytomoatt.src_rec.SrcRec.select_depth.rst create mode 100644 source/modules/src_rec/pytomoatt.src_rec.SrcRec.update.rst diff --git a/source/conf.py b/source/conf.py index a8967b5..343e2c9 100644 --- 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 @@ -76,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 new file mode 100644 index 0000000..d0e68c2 --- /dev/null +++ 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 \ No newline at end of file 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 new file mode 100644 index 0000000..250caac --- /dev/null +++ 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 \ No newline at end of file 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 new file mode 100644 index 0000000..045d530 --- /dev/null +++ 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 \ No newline at end of file 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 new file mode 100644 index 0000000..bc27337 --- /dev/null +++ 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 \ No newline at end of file diff --git a/source/modules/src_rec/pytomoatt.src_rec.SrcRec.update.rst b/source/modules/src_rec/pytomoatt.src_rec.SrcRec.update.rst new file mode 100644 index 0000000..35d229c --- /dev/null +++ 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 \ No newline at end of file diff --git a/source/modules/src_rec/src_rec.rst b/source/modules/src_rec/src_rec.rst index 606dacd..3de9960 100644 --- a/source/modules/src_rec/src_rec.rst +++ b/source/modules/src_rec/src_rec.rst @@ -11,8 +11,8 @@ pytomoatt.src_rec :toctree: . :nosignatures: - ~SrcRec.src_points ~SrcRec.rec_points + ~SrcRec.src_points .. rubric:: Method @@ -20,23 +20,30 @@ pytomoatt.src_rec :toctree: . :nosignatures: - ~SrcRec.read - ~SrcRec.write - ~SrcRec.reset_index + ~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.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 \ No newline at end of file + + \ No newline at end of file