Skip to content

Commit 1a3aa67

Browse files
committed
fixing docs
Signed-off-by: Andrey Parfenov <a1994ndrey@gmail.com>
1 parent b697f98 commit 1a3aa67

8 files changed

Lines changed: 3 additions & 379 deletions

File tree

docs/BrainFlowDev.rst

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,6 @@ Instructions to build docs locally
6565

6666
Don't push changes to Docs without local verification.
6767

68-
- install `pandoc <https://pandoc.org/installing.html>`_
6968
- optional: install Doxygen, skip it if you dont understand what it is or don't need to publish your local build
7069

7170
Install requirements::

docs/Doxyfile.in

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -778,7 +778,7 @@ WARNINGS = YES
778778
# will automatically be disabled.
779779
# The default value is: YES.
780780

781-
WARN_IF_UNDOCUMENTED = YES
781+
WARN_IF_UNDOCUMENTED = NO
782782

783783
# If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for
784784
# potential errors in the documentation, such as not documenting some parameters

docs/Examples.rst

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -664,11 +664,3 @@ Swift ICA
664664

665665
.. literalinclude:: ../swift_package/examples/tests/ica/ica.swift
666666
:language: swift
667-
668-
Notebooks
669-
------------
670-
.. toctree::
671-
672-
./notebooks/brainflow_mne
673-
./notebooks/denoising
674-
./notebooks/band_power

docs/conf.py

Lines changed: 1 addition & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,6 @@
4545
'sphinx.ext.autodoc',
4646
'breathe',
4747
'sphinxcontrib.ghcontributors',
48-
'nbsphinx',
4948
'sphinx.ext.mathjax',
5049
'sphinxcontrib.matlab'
5150
]
@@ -91,12 +90,6 @@ def configure_doxyfile(input_dir, output_dir, project):
9190
configure_doxyfile(input_dir, output_dir, 'BrainFlowCsharp')
9291
subprocess.call('doxygen', shell=True)
9392
breathe_projects['BrainFlowCsharp'] = output_dir + '/xml'
94-
# core api, we dont use it right now but maybe later we will have docs for developers too
95-
input_dir = '../src'
96-
output_dir = 'build-core'
97-
configure_doxyfile(input_dir, output_dir, 'BrainFlowCore')
98-
subprocess.call('doxygen', shell=True)
99-
breathe_projects['BrainFlowCore'] = output_dir + '/xml'
10093

10194

10295
# sphinx.ext.autodoc
@@ -127,22 +120,11 @@ def configure_doxyfile(input_dir, output_dir, project):
127120
# List of patterns, relative to source directory, that match files and
128121
# directories to ignore when looking for source files.
129122
# This pattern also affects html_static_path and html_extra_path.
130-
exclude_patterns = [u'_build', 'Thumbs.db', '.DS_Store', '**.ipynb_checkpoints']
123+
exclude_patterns = [u'_build', 'Thumbs.db', '.DS_Store']
131124

132125
# The name of the Pygments (syntax highlighting) style to use.
133126
pygments_style = None
134127

135-
# options for nbsphinx
136-
html_scaled_image_link = False
137-
html_sourcelink_suffix = ''
138-
139-
nbsphinx_execute_arguments = [
140-
"--InlineBackend.figure_formats={'svg', 'pdf'}",
141-
"--InlineBackend.rc={'figure.dpi': 96}",
142-
]
143-
nbsphinx_input_prompt = 'In [%s]:'
144-
nbsphinx_output_prompt = 'Out[%s]:'
145-
nbsphinx_timeout = 120
146128
# -- Options for HTML output -------------------------------------------------
147129

148130
# The theme to use for HTML and HTML Help pages. See the documentation for

docs/notebooks/band_power.ipynb

Lines changed: 0 additions & 112 deletions
This file was deleted.

docs/notebooks/brainflow_mne.ipynb

Lines changed: 0 additions & 116 deletions
This file was deleted.

0 commit comments

Comments
 (0)