Should fix tests on CI

Signed-off-by: Alexis Jeandet <[email protected]>

Author: jeandet

Makefile

@@ -72,6 +72,9 @@ docs: ## generate Sphinx HTML documentation, including API docs
 	$(MAKE) -C docs html
 	$(BROWSER) docs/_build/html/index.html
 
+doctest:
+	$(MAKE) -C docs doctest
+
 servedocs: docs ## compile the docs watching for changes
 	watchmedo shell-command -p '*.rst' -c '$(MAKE) -C docs html' -R -D .
 

docs/conf.py

@@ -19,7 +19,10 @@
 #
 import os
 import sys
-sys.path.insert(0, os.path.abspath('..'))
+
+src_path = os.path.abspath('..')
+sys.path.insert(0, src_path)
+os.environ['PYTHONPATH'] = src_path
 
 import pyistp
 
@@ -31,7 +34,64 @@
 
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
-extensions = ['sphinx.ext.autodoc', 'sphinx.ext.viewcode']
+extensions = [
+    'sphinx.ext.autodoc',
+    'sphinx.ext.viewcode',
+    'sphinx.ext.doctest',
+    'sphinx.ext.intersphinx',
+    'sphinx.ext.autosectionlabel',
+    'sphinx_gallery.load_style',
+    'sphinx_codeautolink',
+    'sphinxcontrib.apidoc',
+    'nbsphinx',
+    'numpydoc']
+
+apidoc_module_dir = '../pyistp'
+apidoc_output_dir = 'dev'
+apidoc_separate_modules = True
+apidoc_module_first = True
+
+
+autosectionlabel_prefix_document = True
+codeautolink_custom_blocks = {
+    "python3": None,
+    "pycon3": "sphinx_codeautolink.clean_pycon",
+}
+
+nbsphinx_execute_arguments = [
+    "--InlineBackend.figure_formats={'svg', 'pdf'}",
+    "--InlineBackend.rc=figure.dpi=96",
+]
+
+nbsphinx_execute = 'never'
+
+nbsphinx_thumbnails = {
+}
+
+nbsphinx_prolog = r"""
+{% set docname = 'docs/' + env.doc2path(env.docname, base=None) %}
+{% set nb_base = 'tree' if env.config.revision else 'blob' %}
+{% set nb_where = env.config.revision if env.config.revision else 'main' %}
+.. raw:: html
+    <div class="admonition note">
+      <p style="margin-bottom:0px">
+        This page was generated by
+        <a href="https://nbsphinx.readthedocs.io/">nbsphinx</a> from
+        <a class="reference external" href="https://github.com/SciQLop/speasy/{{ nb_base|e }}/{{ nb_where|e }}/{{ docname|e }}">{{ docname|e }}</a>.
+        <br>
+        Interactive online version:
+        <a href="https://mybinder.org/v2/gh/SciQLop/speasy/{{ nb_where|e }}/?labpath={{ docname|e }}"><img alt="Binder badge" src="https://mybinder.org/badge_logo.svg" style="vertical-align:text-bottom"></a>.
+      </p>
+    </div>
+.. raw:: latex
+    \nbsphinxstartnotebook{\scriptsize\noindent\strut
+    \textcolor{gray}{The following section was generated from
+    \sphinxcode{\sphinxupquote{\strut {{ docname | escape_latex }}}} \dotfill}}
+"""
+
+mathjax3_config = {
+    'tex': {'tags': 'ams', 'useLabelIds': True},
+}
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']
@@ -71,6 +131,8 @@
 # This patterns also effect to html_static_path and html_extra_path
 exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
 
+numpydoc_show_class_members = False
+
 # The name of the Pygments (syntax highlighting) style to use.
 pygments_style = 'sphinx'
 
@@ -83,7 +145,7 @@
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
 #
-html_theme = 'alabaster'
+html_theme = 'sphinx_rtd_theme'
 
 # Theme options are theme-specific and customize the look and feel of a
 # theme further.  For a list of options available for each theme, see the
@@ -159,4 +221,10 @@
 ]
 
 
-
+intersphinx_mapping = {'python3': ('https://docs.python.org/3', None),
+                       'numpy': ('https://numpy.org/doc/stable/', None),
+                       'scipy': ('https://docs.scipy.org/doc/scipy/reference/', None),
+                       'matplotlib': ('https://matplotlib.org/stable/', None),
+                       'seaborn': ('https://seaborn.pydata.org/', None),
+                       'astropy': ('https://docs.astropy.org/en/stable/', None),
+                       }

docs/requirements.txt

@@ -0,0 +1,11 @@
+sphinx-rtd-theme
+argh
+numpydoc
+sphinx-gallery
+nbsphinx
+ipympl
+ipywidgets
+sphinx-codeautolink
+astropy
+pandas
+sphinxcontrib-apidoc

tests/test_pyistp.py

@@ -6,9 +6,12 @@
 from ddt import ddt, data, unpack
 
 from pyistp import ISTPLoader
+import os
+
+current_path = os.path.dirname(__file__)
 
 test_data = (
-    ("resources/wi_k0_mfi_20220101_v01.cdf", [
+    (f"{current_path}/resources/wi_k0_mfi_20220101_v01.cdf", [
         "PGSM", "BGSEc", "BF1", "PGSE", "N", "MODE", "BGSMa", "Time_PB5", "DIST", "BGSEa", "BGSMc", "RMS", "DQF",
         "Gap_Flag"]),
 )