Merge pull request #378 from AurelienJaquier/doc-fix

small fix in documentation
BlueBrain · Apr 25, 2024 · b8a1a6a · b8a1a6a
2 parents 2890f80 + 708defe
commit b8a1a6a
Show file tree

Hide file tree

Showing 7 changed files with 22 additions and 5 deletions.
diff --git a/.github/workflows/build-wheels.yml b/.github/workflows/build-wheels.yml
@@ -10,11 +10,11 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        os: [ubuntu-22.04, macos-latest, windows-latest]
+        os: [ubuntu-22.04, macos-12, windows-latest]
         python: [cp39, cp310, cp311, cp312]
         arch: [x86_64, amd64]
         exclude:
-          - os: macos-latest
+          - os: macos-12
             arch: amd64
           - os: ubuntu-22.04
             arch: amd64

diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -84,6 +84,10 @@ jobs:
       run: |
         python -m pip install --upgrade pip setuptools
         pip install tox tox-gh-actions
+    - name: Install pandoc  # needed by nbconvert
+      uses: pandoc/actions/setup@main
+      with:
+        version: 2.19
     - name: Run tox
       run: tox -e docs
 

diff --git a/docs/source/eFeatures.rst b/docs/source/eFeatures.rst
@@ -134,8 +134,8 @@ The interspike intervals, i.e., the time intervals between adjacent peaks.
     else:
         inv_last_ISI = 0
 
-`Python efeature`: inv_ISI_values
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+`Python efeature`_ : inv_ISI_values
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 Computes all inverse spike interval values.
 

diff --git a/docs/source/python_examples.rst b/docs/source/python_examples.rst
@@ -6,4 +6,6 @@ Python
    python_example1
    deap_optimisation
    neoIO_example
+   nmc-portal
+   sonata-network
 
diff --git a/examples/nmc-portal/L5TTPC2.ipynb b/examples/nmc-portal/L5TTPC2.ipynb
@@ -5,7 +5,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "Example of the use of the eFEL (eFeature Extraction Library) in conjunction with models downloaded from the Neocortical Microcircuit Portal website\n",
+    "# Example of the use of the eFEL (eFeature Extraction Library) in conjunction with models downloaded from the Neocortical Microcircuit Portal website\n",
     "\n",
     "Requirements:\n",
     "- Python 3.9+, including Pip (https://pip.readthedocs.org)\n",

diff --git a/requirements_docs.txt b/requirements_docs.txt
@@ -29,3 +29,6 @@ sphinx_rtd_theme>=2.0.0
 sphinx-autobuild>=2021.3.14
 sphinx-autorun>=1.1.1
 sphinx-autodoc-typehints>=1.25.2
+ipython
+jupyter
+pandoc
diff --git a/tox.ini b/tox.ini
@@ -74,9 +74,17 @@ deps =
     pytest>=7.4.4
 allowlist_externals =
     make
+    jupyter
+    cp
 changedir = docs
 
 commands =
+    jupyter nbconvert --to rst ../examples/sonata-network/sonata-network.ipynb
+    jupyter nbconvert --to rst ../examples/nmc-portal/L5TTPC2.ipynb
+    cp ../examples/sonata-network/sonata-network.rst source/
+    cp -r ../examples/sonata-network/sonata-network_files source/
+    cp ../examples/nmc-portal/L5TTPC2.rst source/nmc-portal.rst
+    cp -r ../examples/nmc-portal/L5TTPC2_files source/
     # build the docs to see if it builds fine
     make html SPHINXOPTS=-W
     # make sure the feature names and units are up-to-date