Move the examples folder into the doc folder (#557)

I don't even remember why they didn't live there in the first place.
They are mostly used to generate the gallery. Moved them to
`doc/gallery_src` since that makes much more sense.

Author: leouieda

Makefile

@@ -3,7 +3,7 @@ PROJECT=harmonica
 TESTDIR=tmp-test-dir-with-unique-name
 PYTEST_ARGS=--cov-config=../.coveragerc --cov-report=term-missing --cov=$(PROJECT) --doctest-modules --doctest-continue-on-failure -v --pyargs
 NUMBATEST_ARGS=--doctest-modules -v --pyargs -m use_numba
-STYLE_CHECK_FILES=$(PROJECT) examples doc
+STYLE_CHECK_FILES=$(PROJECT) doc
 GITHUB_ACTIONS=.github/workflows
 
 .PHONY: build install test test_coverage test_numba format check check-format check-style check-actions clean

doc/conf.py

@@ -45,7 +45,7 @@
 intersphinx_mapping = {
     "python": ("https://docs.python.org/3/", None),
     "numpy": ("https://docs.scipy.org/doc/numpy/", None),
-    "numba": ("https://numba.pydata.org/numba-doc/latest/", None),
+    "numba": ("https://numba.readthedocs.io/en/stable/", None),
     "scipy": ("https://docs.scipy.org/doc/scipy/reference", None),
     "pandas": ("http://pandas.pydata.org/pandas-docs/stable/", None),
     "xarray": ("http://xarray.pydata.org/en/stable/", None),
@@ -57,10 +57,6 @@
     "matplotlib": ("https://matplotlib.org/", None),
     "pyproj": ("https://pyproj4.github.io/pyproj/stable/", None),
     "pyvista": ("https://docs.pyvista.org", None),
-    "numba_progress": (
-        "https://pypi.org/project/numba-progress/",
-        None,
-    ),
     "pygmt": ("https://www.pygmt.org/latest/", None),
 }
 
@@ -93,7 +89,7 @@
 # -----------------------------------------------------------------------------
 sphinx_gallery_conf = {
     # path to your examples scripts
-    "examples_dirs": ["../examples"],
+    "examples_dirs": ["gallery_src"],
     # path where to save gallery generated examples
     "gallery_dirs": ["gallery"],
     "filename_pattern": r"\.py",