Skip to content

Commit c484414

Browse files
pablorcumpablorcum
committed
Unable to export HTML in a CI job due to matlab-actions/run-command#14.
As a workaround we will build the documentation offline and push the HTML files to the repo.
1 parent 93eeff2 commit c484414

16 files changed

+703
-2
lines changed

‎.gitignore‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
11
work
2-
toolbox/html
32

43
# Autosave files
54
*.asv

‎buildUtilities/buildDoc.m‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
% Get current project object
2+
projObj = currentProject;
3+
4+
% Export documentation to HTML before packaging toolbox
5+
exportToHTML(fullfile(projObj.RootFolder,'docSource'),fullfile(projObj.RootFolder,'toolbox','html'));

‎buildUtilities/releaseTask.m‎

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,11 @@
1010
projObj = currentProject;
1111

1212
% Export documentation to HTML before packaging toolbox
13-
exportToHTML(fullfile(projObj.RootFolder,'docSource'),fullfile(projObj.RootFolder,'toolbox','html'));
13+
% Errors out in GitHub actions. See https://github.com/matlab-actions/run-command/issues/14
14+
% exportToHTML(fullfile(projObj.RootFolder,'docSource'),fullfile(projObj.RootFolder,'toolbox','html'));
15+
16+
% Build searchable database
17+
builddocsearchdb(fullfile(projObj.RootFolder,'toolbox','html'));
1418

1519
% Remove v from toolboxVersion
1620
options.toolboxVersion = erase(options.toolboxVersion,"v");

‎resources/project/KAXfQgCar2Yb8zOxgvf9hdmLP1E/DKdW6BOEP9cmrIOrp461unCDJZId.xml‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
<?xml version='1.0' encoding='UTF-8'?>
2+
<Info Type="Basic" Visible="1" Icon="" File="buildUtilities/buildDoc.m" Name="buildDoc"/>

‎resources/project/KAXfQgCar2Yb8zOxgvf9hdmLP1E/DKdW6BOEP9cmrIOrp461unCDJZIp.xml‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
<?xml version='1.0' encoding='UTF-8'?>
2+
<Info location="290dceee-4b35-46a1-9a73-9c43e90f291b" type="EntryPoint"/>

‎resources/project/_BcHeyeYYWxz6MENB98iTz25sSI/3hRs76m0VJl1k-4pasoHzIqyAOwd.xml‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
<?xml version='1.0' encoding='UTF-8'?>
2+
<Info>
3+
<Category UUID="FileClassCategory">
4+
<Label UUID="design"/>
5+
</Category>
6+
</Info>

‎resources/project/_BcHeyeYYWxz6MENB98iTz25sSI/3hRs76m0VJl1k-4pasoHzIqyAOwp.xml‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
<?xml version='1.0' encoding='UTF-8'?>
2+
<Info location="buildDoc.m" type="File"/>

‎toolbox/html.html‎

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2+
<html><head><meta http-equiv="Content-Type" content="text/html; charset=utf-8"><meta http-equiv="X-UA-Compatible" content="IE=edge,IE=9,chrome=1"><meta name="generator" content="MATLAB 2023a"><title>User Guide</title><style type="text/css">.rtcContent { padding: 30px; } .S0 { margin: 3px 10px 5px 4px; padding: 0px; line-height: 28.8px; min-height: 0px; white-space: pre-wrap; color: rgb(192, 76, 11); font-family: Helvetica, Arial, sans-serif; font-style: normal; font-size: 24px; font-weight: 400; text-align: left; }
3+
.S1 { margin: 2px 10px 9px 4px; padding: 0px; line-height: 21px; min-height: 0px; white-space: pre-wrap; color: rgb(33, 33, 33); font-family: Helvetica, Arial, sans-serif; font-style: normal; font-size: 14px; font-weight: 400; text-align: left; }
4+
.S2 { margin: 20px 10px 5px 4px; padding: 0px; line-height: 20px; min-height: 0px; white-space: pre-wrap; color: rgb(33, 33, 33); font-family: Helvetica, Arial, sans-serif; font-style: normal; font-size: 20px; font-weight: 700; text-align: left; }
5+
.S3 { border-left: 0px none rgb(33, 33, 33); border-right: 0px none rgb(33, 33, 33); border-top: 0px none rgb(33, 33, 33); border-bottom: 0px none rgb(33, 33, 33); border-radius: 0px; padding: 0px; line-height: 15.6px; min-height: 16px; white-space: pre; color: rgb(33, 33, 33); font-family: Menlo, Monaco, Consolas, "Courier New", monospace; font-size: 12px; }</style></head><body><div class = rtcContent><h1 class = 'S0'><span>User Guide</span></h1><div class = 'S1'><span>The bossdevice API is a set of low-level functions that allows user to control the bossdevice in a user-friendly programmable manner. The combined execution of such low level functions allows the bossdevice to perform certain high level tasks that could be amongst but not limited to generating various number and combination of TTL outputs, timed in a certain fashion, TTL output at a certain Phase of an ongoing EEG Oscillation and guided by the Oscillation Amplitude Thresholds.</span></div><h2 class = 'S2'><span>Initialization</span></h2><div class = 'S1'><span>The bossdevice API can be initialized as a MATLAB Class object and provides access to its methods and functions to generate various TTL outputs and define multiple brain states upon which the predefined TTL output sequence to be released.</span></div><div class = 'preformatted-matlab' style = 'margin: 10px 3px 10px 55px; padding: 10px 10px 10px 5px; '><div class = 'S3'><span style="white-space: pre"><span >bd = bossdevice</span></span></div></div><div class = 'S1'></div>
6+
<br>
7+
<!--
8+
##### SOURCE BEGIN #####
9+
%% User Guide
10+
% The bossdevice API is a set of low-level functions that allows user to control
11+
% the bossdevice in a user-friendly programmable manner. The combined execution
12+
% of such low level functions allows the bossdevice to perform certain high level
13+
% tasks that could be amongst but not limited to generating various number and
14+
% combination of TTL outputs, timed in a certain fashion, TTL output at a certain
15+
% Phase of an ongoing EEG Oscillation and guided by the Oscillation Amplitude
16+
% Thresholds.
17+
%% Initialization
18+
% The bossdevice API can be initialized as a MATLAB Class object and provides
19+
% access to its methods and functions to generate various TTL outputs and define
20+
% multiple brain states upon which the predefined TTL output sequence to be released.
21+
%%
22+
%
23+
% bd = bossdevice
24+
%
25+
%%
26+
%
27+
##### SOURCE END #####
28+
-->
29+
</div></body></html>

‎toolbox/html/biosignal_amplifier_setup.html‎

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

‎toolbox/html/bossdevice_api_examples.html‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2+
<html><head><meta http-equiv="Content-Type" content="text/html; charset=utf-8"><meta http-equiv="X-UA-Compatible" content="IE=edge,IE=9,chrome=1"><meta name="generator" content="MATLAB 2023a"><title>Examples</title><style type="text/css">.rtcContent { padding: 30px; } .S0 { margin: 3px 10px 5px 4px; padding: 0px; line-height: 28.8px; min-height: 0px; white-space: pre-wrap; color: rgb(192, 76, 11); font-family: Helvetica, Arial, sans-serif; font-style: normal; font-size: 24px; font-weight: 400; text-align: left; }</style></head><body><div class = rtcContent><h1 class = 'S0'><span>Examples</span></h1>
3+
<br>
4+
<!--
5+
##### SOURCE BEGIN #####
6+
%% Examples
7+
##### SOURCE END #####
8+
-->
9+
</div></body></html>

0 commit comments

Comments
 (0)