Skip to content

Commit 3531453

Browse files
MIES DeploymentThomas Braun
authored andcommitted
Updating documentation to Release_2.9_20250502-771-g48ae9a022
1 parent 7a0ea52 commit 3531453

325 files changed

Lines changed: 235538 additions & 0 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

CalculateTPLikePropsFromSweep.html

Lines changed: 371 additions & 0 deletions
Large diffs are not rendered by default.

IPNWB/Readme.html

Lines changed: 412 additions & 0 deletions
Large diffs are not rendered by default.

IPNWB/doc/nwb1.html

Lines changed: 266 additions & 0 deletions
Large diffs are not rendered by default.

IPNWB/doc/nwb2.html

Lines changed: 861 additions & 0 deletions
Large diffs are not rendered by default.

SweepFormula.html

Lines changed: 2557 additions & 0 deletions
Large diffs are not rendered by default.

SweepFormula_PSX.html

Lines changed: 353 additions & 0 deletions
Large diffs are not rendered by default.

TPAnalysis_algorithm.html

Lines changed: 587 additions & 0 deletions
Large diffs are not rendered by default.
Lines changed: 78 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,78 @@
1+
From 442b099da06bd393b5ae53211ae2c8026dcef869 Mon Sep 17 00:00:00 2001
2+
From: Thomas Braun <thomas.braun@byte-physics.de>
3+
Date: Wed, 29 Mar 2023 18:18:04 +0200
4+
Subject: [PATCH 1/1] WIP: fast sphinx compilation without breathe
5+
6+
---
7+
Packages/doc/conf.py | 6 +++---
8+
tools/build-documentation.sh | 27 ---------------------------
9+
2 files changed, 3 insertions(+), 30 deletions(-)
10+
11+
diff --git a/Packages/doc/conf.py b/Packages/doc/conf.py
12+
index ad61b69d90..13385ff369 100644
13+
--- a/Packages/doc/conf.py
14+
+++ b/Packages/doc/conf.py
15+
@@ -16,11 +16,11 @@ def get_version():
16+
return "({branch}) {version}".format(branch=branchString.decode('ascii'), version=revString.decode('ascii'))
17+
18+
# sphinx config
19+
-extensions = ['sphinx.ext.mathjax', 'sphinx.ext.todo', 'breathe', \
20+
+extensions = ['sphinx.ext.mathjax', 'sphinx.ext.todo', \
21+
'sphinxcontrib.fulltoc', 'sphinxcontrib.images', \
22+
'sphinxcontrib.youtube']
23+
24+
-master_doc = "index"
25+
+master_doc = "user"
26+
project= "MIES Igor"
27+
28+
html_static_path = ['_static']
29+
@@ -28,7 +28,7 @@ html_static_path = ['_static']
30+
html_copy_source = False
31+
html_show_sourcelink = False
32+
33+
-exclude_patterns = [ 'releasenotes_template.rst', 'IPNWB/specifications']
34+
+exclude_patterns = [ 'releasenotes_template.rst', 'IPNWB/specifications', 'index.rst']
35+
36+
cpp_id_attributes = [ 'threadsafe' ]
37+
38+
diff --git a/tools/build-documentation.sh b/tools/build-documentation.sh
39+
index 1375d65a07..f709100c55 100755
40+
--- a/tools/build-documentation.sh
41+
+++ b/tools/build-documentation.sh
42+
@@ -91,33 +91,6 @@ trap "rm -rf ${top_level}/Packages/doc/IPNWB" EXIT
43+
# workaround https://github.com/sphinx-contrib/images/pull/31
44+
mkdir _video_thumbnail
45+
46+
-if hash breathe-apidoc 2>/dev/null; then
47+
- echo "Start breathe-apidoc"
48+
-
49+
- breathe-apidoc -f -o . xml
50+
-
51+
-else
52+
- echo "Errors building the documentation" 1>&2
53+
- echo "breathe-apidoc could not be found" 1>&2
54+
- exit 1
55+
-fi
56+
-
57+
-# Add labels to each group and each file
58+
-# can be referenced via :ref:`Group LabnotebookQueryFunctions`
59+
-# or :ref:`File MIES_Utilities.ipf`
60+
-
61+
-for i in `ls group/group_*.rst`
62+
-do
63+
- name=$(sed -e '$!d' -e 's/.*doxygengroup:: \(.*\)$/\1/' $i)
64+
- sed -i "1s/^/.. _Group ${name}:\n\n/" $i
65+
-done
66+
-
67+
-for i in `ls file/*.rst`
68+
-do
69+
- name=$(sed -e '$!d' -e 's/.*doxygenfile:: \(.*\)$/\1/' $i)
70+
- sed -i "1s/^/.. _File ${name}:\n\n/" $i
71+
-done
72+
-
73+
# create rst substitutions for up-to-date IP nightly links
74+
grep "IgorPro[0-9]Nightly" $top_level/Packages/MIES_Include.ipf \
75+
| sed -e "s/^\/\/ //" \
76+
--
77+
2.42.0.rc0.windows.1
78+
1.75 KB
Binary file not shown.

_images/AnalysisBrowser.png

122 KB
Loading

0 commit comments

Comments
 (0)