Skip to content

Commit

Permalink
remove empty headings
Browse files Browse the repository at this point in the history
  • Loading branch information
oguyon committed Mar 5, 2024
1 parent a0e3474 commit d6b42d2
Show file tree
Hide file tree
Showing 4 changed files with 70 additions and 68 deletions.
7 changes: 0 additions & 7 deletions index.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,13 +17,6 @@ Use the top navigation bar to access main documentation categories.

cacao is a software framework and toolkit for Adaptive Optics control.

### 1. Milk and cacao

## Advanced Control







Expand Down
22 changes: 0 additions & 22 deletions pages/cacao/cacao_getting_situated.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,28 +35,6 @@ Last access time : 2023-09-29 18:17:24.566123595 -1000
SCRIPT /usr/local/milk/bin/cacao-loops Success
</pre>

<span class="label label-default">Default</span>
<span class="label label-primary">Primary</span>
<span class="label label-success">Success</span>
<span class="label label-info">Info</span>
<span class="label label-warning">Warning</span>
<span class="label label-danger">Danger</span>


{% include note.html content="This is a Note
" %}


{% include tip.html content="This is a Note
" %}

{% include warning.html content="This is a Note
" %}

{% include important.html content="This is a Note
" %}




# Running Commands
Expand Down
26 changes: 26 additions & 0 deletions pages/contributing_documentation.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,32 @@ folder:
This documentation uses markdown syntax, with enhancements.
See [Jekyll theme instructions](https://idratherbewriting.com/documentation-theme-jekyll/index.html) for details.

Example custom syntax:


<span class="label label-default">Default</span>
<span class="label label-primary">Primary</span>
<span class="label label-success">Success</span>
<span class="label label-info">Info</span>
<span class="label label-warning">Warning</span>
<span class="label label-danger">Danger</span>


{% include note.html content="This is a Note
" %}


{% include tip.html content="This is a Note
" %}

{% include warning.html content="This is a Note
" %}

{% include important.html content="This is a Note
" %}



Use the "Edit me" button at the top of the page (below title), or edit the .md file in a local copy of the documentation, following usual git practices.

# Building the documentation page
Expand Down
83 changes: 44 additions & 39 deletions pages/milk/milk_function_parameter_structures.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ summary: "Function Parameter Structures (FPS) hold variables for processes"
sidebar: home_sidebar
permalink: milk_function_parameter_structures.html
folder: milk
datatable: true
---


Expand Down Expand Up @@ -144,25 +145,23 @@ rescan Rescan fps tree

## Controlling processes

<pre>
<div class="datatable-begin"></div>

Command Description Argument(s)
Command | Description | Argument(s)
------------ | ---------------------------- | --------
confstart | Start conf process | keyword
confstop | Stop conf process | keyword
confupdate | Update conf process | keyword
confwupdate | Update conf process, wait for completion before processing next command | keyword
runstart | Start run process | keyword
runstop | Stop run process | keyword
setval | Set value | keyword, value
tmuxstart | Start tmux session | keyword
tmuxstop | Stop tmux session | keyword
fpsrm | Remove fps | keyword

confstart Start conf process keyword
confstop Stop conf process keyword
confupdate Update conf process keyword
confwupdate Update conf process, keyword
wait for completion
before processing
next command
runstart Start run process keyword
runstop Stop run process keyword
setval Set value keyword, value
tmuxstart Start tmux session keyword
tmuxstop Stop tmux session keyword
fpsrm Remove fps keyword
<div class="datatable-end"></div>

</pre>

Only the setval command requires an exact full keyword (for example mfilt-2.loopON). Other commands will only use the first part of the keyword (mfilt-2) and disregard the rest of the keyword, which is then optional.

Expand All @@ -171,33 +170,39 @@ Only the setval command requires an exact full keyword (for example mfilt-2.loop

## Getting status

<pre>
Command Description Argument(s)
fpswfile Write fps content to keyword
txt file in datadir
getval Get value, write to keyword
output log
fwrval Get value, write to keyword, fname
file or fifo
cntinc Counter test to check
input fifo connection
​</pre>
<div class="datatable-begin"></div>

Command | Description | Argument(s)
------------ | ---------------------------- | --------
fpswfile | Write fps content to txt file in datadir | keyword
getval | Get value, write to output log | keyword
fwrval | Get value, write to file or fifo | keyword, fname
cntinc | Counter test to check input fifo connection |

<div class="datatable-end"></div>



## Execution Queues and Sequencing


<pre>
Command Description Argument(s)

setqindex Set queue index queue index
setqprio Set current queue priority priority
queueprio Set any queue priority queue, priority
waitonrunON Toggle wait-on-run ON
​waitonrunOFF Toggle wait-on-run OFF
​waitonconfON Toggle wait-on-conf ON
waitonconfOFF Toggle wait-on-conf OFF
​</pre>

<div class="datatable-begin"></div>

Command | Description | Argument(s)
------------ | ---------------------------- | --------
setqindex | Set queue index | queue index
setqprio | Set current queue priority | priority
queueprio | Set any queue priority | queue, priority
waitonrunON | Toggle wait-on-run ON |
​waitonrunOFF | Toggle wait-on-run OFF |
​waitonconfON | Toggle wait-on-conf ON |
waitonconfOFF| Toggle wait-on-conf OFF |

<div class="datatable-end"></div>






Expand Down

0 comments on commit d6b42d2

Please sign in to comment.