Skip to content

Commit

Permalink
Updating documentation to Release_2.7_20230809-1037-g177bfaac0af
Browse files Browse the repository at this point in the history
  • Loading branch information
MIES Deployment authored and Thomas Braun committed Sep 4, 2024
1 parent 7a0ea52 commit 5ea4987
Show file tree
Hide file tree
Showing 317 changed files with 221,735 additions and 0 deletions.
369 changes: 369 additions & 0 deletions CalculateTPLikePropsFromSweep.html

Large diffs are not rendered by default.

264 changes: 264 additions & 0 deletions IPNWB/doc/nwb1.html

Large diffs are not rendered by default.

523 changes: 523 additions & 0 deletions IPNWB/doc/nwb2.html

Large diffs are not rendered by default.

390 changes: 390 additions & 0 deletions IPNWB/index.html

Large diffs are not rendered by default.

1,886 changes: 1,886 additions & 0 deletions SweepFormula.html

Large diffs are not rendered by default.

319 changes: 319 additions & 0 deletions SweepFormula_PSX.html

Large diffs are not rendered by default.

584 changes: 584 additions & 0 deletions TPAnalysis_algorithm.html

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
@@ -0,0 +1,78 @@
From 442b099da06bd393b5ae53211ae2c8026dcef869 Mon Sep 17 00:00:00 2001
From: Thomas Braun <[email protected]>
Date: Wed, 29 Mar 2023 18:18:04 +0200
Subject: [PATCH 1/1] WIP: fast sphinx compilation without breathe

---
Packages/doc/conf.py | 6 +++---
tools/build-documentation.sh | 27 ---------------------------
2 files changed, 3 insertions(+), 30 deletions(-)

diff --git a/Packages/doc/conf.py b/Packages/doc/conf.py
index ad61b69d90..13385ff369 100644
--- a/Packages/doc/conf.py
+++ b/Packages/doc/conf.py
@@ -16,11 +16,11 @@ def get_version():
return "({branch}) {version}".format(branch=branchString.decode('ascii'), version=revString.decode('ascii'))

# sphinx config
-extensions = ['sphinx.ext.mathjax', 'sphinx.ext.todo', 'breathe', \
+extensions = ['sphinx.ext.mathjax', 'sphinx.ext.todo', \
'sphinxcontrib.fulltoc', 'sphinxcontrib.images', \
'sphinxcontrib.youtube']

-master_doc = "index"
+master_doc = "user"
project= "MIES Igor"

html_static_path = ['_static']
@@ -28,7 +28,7 @@ html_static_path = ['_static']
html_copy_source = False
html_show_sourcelink = False

-exclude_patterns = [ 'releasenotes_template.rst', 'IPNWB/specifications']
+exclude_patterns = [ 'releasenotes_template.rst', 'IPNWB/specifications', 'index.rst']

cpp_id_attributes = [ 'threadsafe' ]

diff --git a/tools/build-documentation.sh b/tools/build-documentation.sh
index 1375d65a07..f709100c55 100755
--- a/tools/build-documentation.sh
+++ b/tools/build-documentation.sh
@@ -91,33 +91,6 @@ trap "rm -rf ${top_level}/Packages/doc/IPNWB" EXIT
# workaround https://github.com/sphinx-contrib/images/pull/31
mkdir _video_thumbnail

-if hash breathe-apidoc 2>/dev/null; then
- echo "Start breathe-apidoc"
-
- breathe-apidoc -f -o . xml
-
-else
- echo "Errors building the documentation" 1>&2
- echo "breathe-apidoc could not be found" 1>&2
- exit 1
-fi
-
-# Add labels to each group and each file
-# can be referenced via :ref:`Group LabnotebookQueryFunctions`
-# or :ref:`File MIES_Utilities.ipf`
-
-for i in `ls group/group_*.rst`
-do
- name=$(sed -e '$!d' -e 's/.*doxygengroup:: \(.*\)$/\1/' $i)
- sed -i "1s/^/.. _Group ${name}:\n\n/" $i
-done
-
-for i in `ls file/*.rst`
-do
- name=$(sed -e '$!d' -e 's/.*doxygenfile:: \(.*\)$/\1/' $i)
- sed -i "1s/^/.. _File ${name}:\n\n/" $i
-done
-
# create rst substitutions for up-to-date IP nightly links
grep "IgorPro[0-9]Nightly" $top_level/Packages/MIES_Include.ipf \
| sed -e "s/^\/\/ //" \
--
2.42.0.rc0.windows.1

Binary file not shown.
Binary file added _images/AnalysisBrowser.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added _images/Browser-SettingsHistory.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added _images/Browser-SweepControl.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added _images/Browser-all.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added _images/BrowserSettingsPanel-Artefact-Removal.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added _images/BrowserSettingsPanel-ChannelSelection.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added _images/BrowserSettingsPanel-Dashboard.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added _images/BrowserSettingsPanel-Note.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added _images/BrowserSettingsPanel-Overlay-Sweeps.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added _images/BrowserSettingsPanel-PA-plot.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added _images/BrowserSettingsPanel-Settings.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added _images/BrowserSettingsPanel-Sweepformula.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1,578 changes: 1,578 additions & 0 deletions _images/CalculateTPLikePropsFromSweep.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added _images/DAEphys-Data_Acquisition.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added _images/PulseAverage_images.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added _images/PulseAverage_images_colorscales.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added _images/PulseAverage_traces.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added _images/RelevantColors.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added _images/SweepFormula-PSX-GUI.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading

0 comments on commit 5ea4987

Please sign in to comment.