stability fixes for docs

Signed-off-by: Andrey Parfenov <a1994ndrey@gmail.com>
brainflow-dev · Dec 16, 2023 · f0c2f6f · f0c2f6f
1 parent cc833cf
commit f0c2f6f
Show file tree

Hide file tree

Showing 7 changed files with 23 additions and 17 deletions.
diff --git a/docs/Doxyfile.in b/docs/Doxyfile.in
@@ -601,7 +601,7 @@ FORCE_LOCAL_INCLUDES   = NO
 # documentation for inline members.
 # The default value is: YES.
 
-INLINE_INFO            = YES
+INLINE_INFO            = NO
 
 # If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the
 # (detailed) documentation of file and class members alphabetically by member

diff --git a/docs/UserAPI.rst b/docs/UserAPI.rst
@@ -63,23 +63,20 @@ BoardShim class
 .. doxygenclass:: BoardShim
    :members:
    :project: BrainFlowCpp
-   :undoc-members:
 
 DataFilter class
 ~~~~~~~~~~~~~~~~~~
 
 .. doxygenclass:: DataFilter
    :members:
    :project: BrainFlowCpp
-   :undoc-members:
 
 MLModel class
 ~~~~~~~~~~~~~~~~~~~~~~~~~
 
 .. doxygenclass:: MLModel
    :members:
    :project: BrainFlowCpp
-   :undoc-members:
 
 BrainFlow constants
 ~~~~~~~~~~~~~~~~~~~~~
@@ -94,7 +91,6 @@ Content of Brainflow Package:
 
 .. doxygennamespace:: brainflow
    :project: BrainFlowJava
-   :undoc-members:
    :members:
    :content-only:
 
@@ -106,7 +102,6 @@ Content of brainflow namespace:
 
 .. doxygennamespace:: brainflow
    :project: BrainFlowCsharp
-   :undoc-members:
    :members:
    :content-only:
 
@@ -134,7 +129,6 @@ A few general rules to keep in mind:
 
 .. mat:automodule:: brainflow
    :members:
-   :undoc-members:
    :show-inheritance:
 
 

diff --git a/docs/conf.py b/docs/conf.py
@@ -91,7 +91,7 @@ def configure_doxyfile(input_dir, output_dir, project):
     configure_doxyfile(input_dir, output_dir, 'BrainFlowCsharp')
     subprocess.call('doxygen', shell=True)
     breathe_projects['BrainFlowCsharp'] = output_dir + '/xml'
-    # core api, we dont use it right now but maybe later we will docs for developers too
+    # core api, we dont use it right now but maybe later we will have docs for developers too
     input_dir = '../src'
     output_dir = 'build-core'
     configure_doxyfile(input_dir, output_dir, 'BrainFlowCore')
@@ -142,7 +142,7 @@ def configure_doxyfile(input_dir, output_dir, project):
 ]
 nbsphinx_input_prompt = 'In [%s]:'
 nbsphinx_output_prompt = 'Out[%s]:'
-nbsphinx_timeout = 60
+nbsphinx_timeout = 120
 # -- Options for HTML output -------------------------------------------------
 
 # The theme to use for HTML and HTML Help pages.  See the documentation for

diff --git a/docs/notebooks/band_power.ipynb b/docs/notebooks/band_power.ipynb
@@ -2,7 +2,11 @@
  "cells": [
   {
    "cell_type": "markdown",
-   "metadata": {},
+   "metadata": {
+    "execution": {
+     "timeout": 300
+    }
+   },
    "source": [
     "# BrainFlow Band Power Notebook"
    ]

diff --git a/docs/notebooks/brainflow_mne.ipynb b/docs/notebooks/brainflow_mne.ipynb
@@ -2,7 +2,11 @@
  "cells": [
   {
    "cell_type": "markdown",
-   "metadata": {},
+   "metadata": {
+    "execution": {
+     "timeout": 300
+    }
+   },
    "source": [
     "# BrainFlow to MNE Python Notebook"
    ]

diff --git a/docs/notebooks/denoising.ipynb b/docs/notebooks/denoising.ipynb
@@ -2,7 +2,11 @@
  "cells": [
   {
    "cell_type": "markdown",
-   "metadata": {},
+   "metadata": {
+    "execution": {
+     "timeout": 300
+    }
+   },
    "source": [
     "# Denoising Notebook"
    ]

diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -1,15 +1,15 @@
-sphinx==3.1.2
-breathe==4.19.2
+sphinx==4.0.2
+breathe==4.33.1
 brainflow
 pandas
-mne
+mne==1.5.0
 matplotlib
 ipykernel
 nbsphinx
 pandoc
 sphinxcontrib-ghcontributors
 Pygments==2.7.4
-sphinxcontrib-matlabdomain==0.11.4
+sphinxcontrib-matlabdomain==0.19.1
 docutils<0.17
 sphinx_rtd_theme==0.4.3
-jinja2<3.1
+jinja2==3.1.2