Merge pull request #7 from ColmTalbot/timing-notebook

EXAMPLE: add example notebooks
ColmTalbot · Jun 14, 2024 · 6b23fe5 · 6b23fe5
2 parents 8d31ff7 + f795a0f
commit 6b23fe5
Show file tree

Hide file tree

Showing 6 changed files with 2,668 additions and 8 deletions.
diff --git a/.github/workflows/pages.yml b/.github/workflows/pages.yml
@@ -43,7 +43,8 @@ jobs:
 
       - name: Build documentation
         run: |
-          # cp examples/*.ipynb docs
+          cp examples/wcosmo_timing.ipynb doc/source/examples/timing.ipynb
+          cp examples/wcosmo_gwtc3.ipynb doc/source/examples/gwtc3.ipynb
           cd doc
           make clean
           make html

diff --git a/.gitignore b/.gitignore
@@ -3,5 +3,6 @@
 build/
 doc/build/
 doc/source/api/
+doc/source/examples/*.ipynb
 .coverage
 wcosmo/_version.py
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -4,11 +4,6 @@ repos:
     hooks:
       - id: black
         language_version: python3
--   repo: https://github.com/ambv/black
-    rev: 24.4.2
-    hooks:
-      - id: black-jupyter
-        language_version: python3
 -   repo: https://github.com/pre-commit/pre-commit-hooks
     rev: v4.6.0
     hooks:

diff --git a/doc/source/examples/index.rst b/doc/source/examples/index.rst
@@ -1,5 +1,8 @@
 Examples
 ========
 
-.. attention::
-   No example notebooks are available yet.
+.. toctree::
+   :maxdepth: 1
+
+   gwtc3
+   timing