Skip to content

Commit

Permalink
Checkpoint after updating doxygen posted results to otsdaq.fnal.gov
Browse files Browse the repository at this point in the history
  • Loading branch information
@rrivera747
rrivera747 committed Feb 18, 2025
1 parent 2bd3e58 commit 83a0932
Show file tree
Hide file tree
Showing 5 changed files with 83 additions and 38 deletions.
6 changes: 4 additions & 2 deletions onlineDoc/doxygen_main_editor.cpp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,13 +7,15 @@
/// Planned to be used in conjunction with OnlineDocPushUpdate.sh
///
/// compile with:
/// g++ doxygen_main_editor.cpp -o hw.o
/// g++ doxygen_main_editor.cpp -o doxygen_main_editor
/// or
/// g++ ./srcs/otsdaq-utilities/onlineDoc/doxygen_main_editor.cpp -o doxygen_main_editor
///
/// if developing, consider appending -D_GLIBCXX_DEBUG to get more
/// descriptive error messages
///
/// run with:
///./doxygen_main_editor.o <full main.html path> <full inject main html file path>
///./doxygen_main_editor <full main.html path> <full inject main html file path>
///
///
#include <arpa/inet.h>
Expand Down
28 changes: 28 additions & 0 deletions onlineDoc/index.html
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
<!DOCTYPE html>
<html><body>
<a href="https://artdaq.fnal.gov/Doxygen/">artdaq/</a><br/>
<a href="https://artdaq.fnal.gov/Doxygen/v3_16_00/artdaq-core/">artdaq-core/</a><br/>
<a href="https://artdaq.fnal.gov/Doxygen/v3_16_00/artdaq-core-demo/">artdaq-core-demo/</a><br/>
<a href="https://artdaq.fnal.gov/Doxygen/v3_16_00/artdaq-demo/">artdaq-demo/</a><br/>
<a href="https://artdaq.fnal.gov/Doxygen/v3_16_00/artdaq-epics-plugin/">artdaq-epics-plugin/</a><br/>
<!-- <a href="artdaq_ganglia_plugin/">artdaq_ganglia_plugin/</a><br/> -->
<a href="https://artdaq.fnal.gov/Doxygen/v3_16_00/artdaq-mfextensions/">artdaq-mfextensions/</a><br/>
<!-- <a href="artdaq_mpich_plugin/">artdaq_mpich_plugin/</a><br/> -->
<a href="https://artdaq.fnal.gov/Doxygen/v3_16_00/artdaq-utilities/">artdaq-utilities/</a><br/>
<br><br>
<a href="otsdaq/">otsdaq/</a><br/>
<a href="otsdaq-utilities/">otsdaq-utilities/</a><br/>
<a href="otsdaq-components/">otsdaq-components/</a><br/>
<a href="otsdaq-demo/">otsdaq-demo/</a><br/>
<a href="otsdaq-prepmodernization/">otsdaq-prepmodernization/</a><br/>
<a href="otsdaq-epics/">otsdaq-epics/</a><br/>
<!-- <a href="otsdaq-fermilabtestbeam/">otsdaq_fermilabtestbeam/</a><br/> -->
<br><br>
<a href="otsdaq-mu2e/">otsdaq-mu2e/</a><br/>
<a href="otsdaq-mu2e-calorimeter/">otsdaq-mu2e-calorimeter/</a><br/>
<a href="otsdaq-mu2e-crv/">otsdaq-mu2e-crv/</a><br/>
<a href="otsdaq-mu2e-tracker/">otsdaq-mu2e-tracker/</a><br/>
<a href="otsdaq-mu2e-extmon/">otsdaq-mu2e-extmon/</a><br/>
<a href="otsdaq-mu2e-stm/">otsdaq-mu2e-stm/</a><br/>
<a href="otsdaq-mu2e-trigger/">otsdaq-mu2e-trigger/</a><br/>
</body></html>
48 changes: 24 additions & 24 deletions onlineDoc/inject_otsdaq.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -29,26 +29,26 @@ <h1 style="font-family: 'Comfortaa', arial;">Welcome to the otsdaq Source Code D

<br>
<br>
<i>otsdaq</i> is composed of three core repositories (otsdaq, otsdaq_utilities, and otsdaq_components) and one example user repository (otsdaq_demo).
The intention is for users to clone otsdaq_demo into one or many of their own repositories for their own specific applications.
<i>otsdaq</i> is composed of three core repositories (otsdaq, otsdaq-utilities, and otsdaq-components) and one example user repository (otsdaq-demo).
The intention is for users to clone otsdaq-demo into one or many of their own repositories for their own specific applications.
Here are the links to the source code documentation for each respository:
<br><br>
<div style='margin-left:40px'>
<li><a href='https://otsdaq.fnal.gov/docs/code/otsdaq/'>otsdaq</a>
<li><a href='https://otsdaq.fnal.gov/docs/code/otsdaq_utilities/'>otsdaq_utilities</a>
<li><a href='https://otsdaq.fnal.gov/docs/code/otsdaq_components/'>otsdaq_components</a>
<li><a href='https://otsdaq.fnal.gov/docs/code/otsdaq_demo/'>otsdaq_demo</a>
<li><a href='https://otsdaq.fnal.gov/docs/code/otsdaq-utilities/'>otsdaq-utilities</a>
<li><a href='https://otsdaq.fnal.gov/docs/code/otsdaq-components/'>otsdaq-components</a>
<li><a href='https://otsdaq.fnal.gov/docs/code/otsdaq-demo/'>otsdaq-demo</a>
</div>

<br>
<br>
<i>otsdaq</i> is built on top of the <i>artdaq</i> toolkit and the XDAQ toolkit:
<br><br>
<div style='margin-left:40px'>
<li><a target='_blank'href='http://artdaq.fnal.gov'><i>artdaq</i></a>
<li><a target='_blank'href='https://artdaq.fnal.gov'><i>artdaq</i> homepage</a>
<!--<li><a target='_blank' href='https://svnweb.cern.ch/trac/cmsos'>XDAQ</a>-->
<li><a target='_blank' href='https://twiki.cern.ch/twiki/bin/view/CMSPublic/CMSOS'>XDAQ</a>
<li><a target='_blank' href='https://otsdaq.fnal.gov'>otsdaq</a>
<li><a target='_blank' href='https://twiki.cern.ch/twiki/bin/view/CMSPublic/CMSOS'>XDAQ homepage</a>
<li><a target='_blank' href='https://otsdaq.fnal.gov'><i>otsdaq</i> homepage</a>
</div>


Expand Down Expand Up @@ -84,9 +84,9 @@ <h1>Supervisor Base Classes</h1>
or that need a state machines driven by the Gateway Supervisor.
</td></tr>

<!-- :::::::::::: -->
<!-- :::::::::::: old doxygen xdaq link: https://xdaq.web.cern.ch/xdaq/doxygen/baseline14/classxdaq_1_1Application.html -->
<tr><td>
<a href='https://xdaq.web.cern.ch/xdaq/doxygen/baseline14/classxdaq_1_1Application.html'>
<a href='https://twiki.cern.ch/twiki/bin/view/CMSPublic/CMSOS'>
xdaq::Application
</a>
</td><td>
Expand Down Expand Up @@ -123,7 +123,7 @@ <h1>Supervisor Base Classes</h1>
<div class='topicDiv'><br><br><a href='#topicList'>Jump to Topics List</a>
<h1><i>otsdaq</i> Core Supervisors</h1>
<div class='topicDescDiv'>
The otsdaq Core Supervisors are the supervisors provided with otsdaq and otsdaq_utilities distribution.
The otsdaq Core Supervisors are the supervisors provided with otsdaq and otsdaq-utilities distribution.
</div>
<table>
<tr><th class='topicClassNameCol'>
Expand Down Expand Up @@ -175,42 +175,42 @@ <h1><i>otsdaq</i> Core Supervisors</h1>
</td></tr>
<!-- :::::::::::: -->
<tr><td>
<a href='https://otsdaq.fnal.gov/docs/code/otsdaq_utilities/classots_1_1_chat_supervisor.html'>
<a href='https://otsdaq.fnal.gov/docs/code/otsdaq-utilities/classots_1_1_chat_supervisor.html'>
ChatSupervisor
</a>
</td><td>This class handles the otsdaq user chat functionality available in the web desktop environment.
</td></tr>
<!-- :::::::::::: -->
<tr><td>
<a href='https://otsdaq.fnal.gov/docs/code/otsdaq_utilities/classots_1_1_configuration_g_u_i_supervisor.html'>
<a href='https://otsdaq.fnal.gov/docs/code/otsdaq-utilities/classots_1_1_configuration_g_u_i_supervisor.html'>
ConfigurationGUISupervisor
</a>
</td><td>This class handles the user requests to read and write the Configuration Tree.
</td></tr>
<!-- :::::::::::: -->
<tr><td>
<a href='https://otsdaq.fnal.gov/docs/code/otsdaq_utilities/classots_1_1_console_supervisor.html'>
<a href='https://otsdaq.fnal.gov/docs/code/otsdaq-utilities/classots_1_1_console_supervisor.html'>
ConsoleSupervisor
</a>
</td><td>This class handles the presentation of Message Facility printouts to the web desktop Console.
</td></tr>
<!-- :::::::::::: -->
<tr><td>
<a href='https://otsdaq.fnal.gov/docs/code/otsdaq_utilities/classots_1_1_slow_controls_dashboard_supervisor.html'>
<a href='https://otsdaq.fnal.gov/docs/code/otsdaq-utilities/classots_1_1_slow_controls_dashboard_supervisor.html'>
SlowControlsDashboardSupervisor
</a>
</td><td>This class handles the management of slow controls interface plugins, as well as the user web interface.
</td></tr>
<!-- :::::::::::: -->
<tr><td>
<a href='https://otsdaq.fnal.gov/docs/code/otsdaq_utilities/classots_1_1_logbook_supervisor.html'>
<a href='https://otsdaq.fnal.gov/docs/code/otsdaq-utilities/classots_1_1_logbook_supervisor.html'>
LogbookSupervisor
</a>
</td><td>This class handles the write and read requests for web users interfacing to the web desktop Logbook.
</td></tr>
<!-- :::::::::::: -->
<tr><td>
<a href='https://otsdaq.fnal.gov/docs/code/otsdaq_utilities/classots_1_1_macro_maker_supervisor.html'>
<a href='https://otsdaq.fnal.gov/docs/code/otsdaq-utilities/classots_1_1_macro_maker_supervisor.html'>
MacroMakerSupervisor
</a>
</td><td>This class handles the user interface to the web desktop MacroMaker. MacroMaker
Expand All @@ -219,7 +219,7 @@ <h1><i>otsdaq</i> Core Supervisors</h1>
</td></tr>
<!-- :::::::::::: -->
<tr><td>
<a href='https://otsdaq.fnal.gov/docs/code/otsdaq_utilities/classots_1_1_visual_supervisor.html'>
<a href='https://otsdaq.fnal.gov/docs/code/otsdaq-utilities/classots_1_1_visual_supervisor.html'>
VisualSupervisor
</a>
</td><td>This class handles the web user interface to a VisualDataManager with reqgard to the web desktop Visualizer.
Expand Down Expand Up @@ -326,7 +326,7 @@ <h1>Front-ends</h1>
</td></tr>
<!-- :::::::::::: -->
<tr><td>
<a href='https://otsdaq.fnal.gov/docs/code/otsdaq/classots_1_1_f_e_v_interfaces_manager.html'>
<a href='https://otsdaq.fnal.gov/docs/code/otsdaq/classots_1_1_f_e_v_interface.html'>
FEVInterface
</a>
</td><td>This class is a virtual class defining the features of front-end interface plugin class.
Expand Down Expand Up @@ -520,7 +520,7 @@ <h1>Visualization and DQM</h1>

<!-- :::::::::::: -->
<tr><td>
<a href='https://otsdaq.fnal.gov/docs/code/otsdaq_utilities/classots_1_1_visual_supervisor.html'>
<a href='https://otsdaq.fnal.gov/docs/code/otsdaq-utilities/classots_1_1_visual_supervisor.html'>
VisualSupervisor
</a>
</td><td>This class is the web server to visualize objects found on disk and also the
Expand All @@ -531,7 +531,7 @@ <h1>Visualization and DQM</h1>
</td></tr>
<!-- :::::::::::: -->
<tr><td>
<a href='https://otsdaq.fnal.gov/docs/code/otsdaq_utilities/classots_1_1_visual_data_manager.html'>
<a href='https://otsdaq.fnal.gov/docs/code/otsdaq-utilities/classots_1_1_visual_data_manager.html'>
VisualDataManager
</a>
</td><td>This class provides functionality for handling Visualizer data consumer plugin classes
Expand Down Expand Up @@ -579,7 +579,7 @@ <h1>Slow Controls</h1>

<!-- :::::::::::: -->
<tr><td>
<a href='https://otsdaq.fnal.gov/docs/code/otsdaq_utilities/classots_1_1_slow_controls_dashboard_supervisor.html'>
<a href='https://otsdaq.fnal.gov/docs/code/otsdaq-utilities/classots_1_1_slow_controls_dashboard_supervisor.html'>
SlowControlsDashboardSupervisor
</a>
</td><td>This class is the web server and also the
Expand All @@ -598,7 +598,7 @@ <h1>Slow Controls</h1>
</td></tr>
<!-- :::::::::::: -->
<tr><td>
<a href='https://otsdaq.fnal.gov/docs/code/otsdaq_components/class_ots_slow_controls_interface.html'>
<a href='https://otsdaq.fnal.gov/docs/code/otsdaq-components/class_ots_slow_controls_interface.html'>
OtsSlowControlsInterface
</a>
</td><td>This class is an example slow controls interface plugin inheriting functionality from
Expand All @@ -607,7 +607,7 @@ <h1>Slow Controls</h1>
</td></tr>
<!-- :::::::::::: -->
<tr><td>
<a target='_blank' href='https://otsdaq.fnal.gov/docs/code/otsdaq_epics/classots_1_1_epics_interface.html'>
<a target='_blank' href='https://otsdaq.fnal.gov/docs/code/otsdaq-epics/classots_1_1_epics_interface.html'>
EpicsInterface
</a>
</td><td>This class is the EPICS slow controls interface plugin inheriting functionality from
Expand Down
18 changes: 9 additions & 9 deletions onlineDoc/inject_otsdaq_utilities.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,32 +5,32 @@

<h1 style="font-family: 'Comfortaa', arial;">Welcome to the <i>otsdaq</i> Source Code Documentation</h1>

<a href="http://otsdaq.fnal.gov">
<a href="https://otsdaq.fnal.gov">
<img style='margin-left:6px; margin-bottom:10px; width:150px;' border='0' src='/logo.png'>
</a>

<br>
<br>
<i>otsdaq</i> is composed of three core repositories (otsdaq, otsdaq_utilities, and otsdaq_components) and one example user repository (otsdaq_demo).
The intention is for users to clone otsdaq_demo into one or many of their own repositories for their own specific applications.
<i>otsdaq</i> is composed of three core repositories (otsdaq, otsdaq-utilities, and otsdaq-components) and one example user repository (otsdaq-demo).
The intention is for users to clone otsdaq-demo into one or many of their own repositories for their own specific applications.
Here are the links to the source code documentation for each respository:
<br><br>
<div style='margin-left:40px'>
<li><a href='https://otsdaq.fnal.gov/docs/code/otsdaq/'>otsdaq</a> - with additional high-level topics and helpful links
<li><a href='https://otsdaq.fnal.gov/docs/code/otsdaq_utilities/'>otsdaq_utilities</a>
<li><a href='https://otsdaq.fnal.gov/docs/code/otsdaq_components/'>otsdaq_components</a>
<li><a href='https://otsdaq.fnal.gov/docs/code/otsdaq_demo/'>otsdaq_demo</a>
<li><a href='https://otsdaq.fnal.gov/docs/code/otsdaq-utilities/'>otsdaq-utilities</a>
<li><a href='https://otsdaq.fnal.gov/docs/code/otsdaq-components/'>otsdaq-components</a>
<li><a href='https://otsdaq.fnal.gov/docs/code/otsdaq-demo/'>otsdaq-demo</a>
</div>

<br>
<br>
<i>otsdaq</i> is built on top of the <i>artdaq</i> toolkit and the XDAQ toolkit:
<br><br>
<div style='margin-left:40px'>
<li><a target='_blank'href='http://artdaq.fnal.gov'><i>artdaq</i></a>
<li><a target='_blank'href='https://artdaq.fnal.gov'><i>artdaq</i> homepage</a>
<!--<li><a target='_blank' href='https://svnweb.cern.ch/trac/cmsos'>XDAQ</a>-->
<li><a target='_blank' href='https://twiki.cern.ch/twiki/bin/view/CMSPublic/CMSOS'>XDAQ</a>
<li><a target='_blank' href='http://otsdaq.fnal.gov'>otsdaq</a>
<li><a target='_blank' href='https://twiki.cern.ch/twiki/bin/view/CMSPublic/CMSOS'>XDAQ homepage</a>
<li><a target='_blank' href='https://otsdaq.fnal.gov'><i>otsdaq</i> homepage</a>
</div>


Expand Down
21 changes: 18 additions & 3 deletions tools/OnlineDocPushUpdate.sh
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,17 +8,20 @@
# export OTS_WEB_USER="name"
# export OTS_WEB_HOST="host"
#
# For example: ./srcs/otsdaq-utilities/tools/OnlineDocPushUpdate.sh 1 1 1
# For example: ./srcs/otsdaq-utilities/tools/OnlineDocPushUpdate.sh 1 1 1 #<do NOT do mrb z> <only transfer main page> <transfer to dev area>
#
# Note: people keep commenting out CMakeLists requirements when doxygen causes issues,
# so remember to have 'add_subdirectory(doc)' in repo/CMakeLists.txt
# and ... 'include(artdaq_doxygen) \n create_doxygen_documentation()' in repo/doc/CMakeLists.txt
# NOW -- export OTS_DOXY=DOIT #to enable doxygen doc creation
#
#
# Note: with option do MRB Z, this script calls ./doxygen_main_editor
# to avoid requiring a successful compile:
# g++ ./srcs/otsdaq-utilities/onlineDoc/doxygen_main_editor.cpp -o doxygen_main_editor
#
# If an area is not formatted for doxygen style documentation, can apply temporarily/permanently:
#
# ./otsdaq-utilities/tools/convert_header_comments_to_doxygen.sh <path>
# g++ ./srcs/otsdaq-utilities/tools/convert_comments_to_doxygen.cpp -o convert_comments_to_doxygen
# ./convert_comments_to_doxygen <path>
#
Expand Down Expand Up @@ -145,6 +148,7 @@ for p in ${REPO_DIR[@]}; do
#cp $p/doc/html/main.html $p/doc/html/main.html.bk
cp $p/doc/html/index.html $p/doc/html/index.html.bk
fi
# cp $p/doc/html/index.html $p/doc/html/index.html.bk #for debugging

echo
echo -e "OnlineDocPushUpdate.sh:${LINENO} \t =================="
Expand All @@ -154,6 +158,14 @@ for p in ${REPO_DIR[@]}; do

#doxygen_main_editor $p/doc/html/main.html $SCRIPT_DIR/../../../srcs/otsdaq_utilities/onlineDoc/inject_$(basename $p).html $SCRIPT_DIR/../../../srcs/otsdaq_utilities/onlineDoc/inject_otsdaq_head.html
# doxygen_main_editor $p/doc/html/index.html $SCRIPT_DIR/../../../srcs/otsdaq_utilities/onlineDoc/inject_$(basename $p).html $SCRIPT_DIR/../../../srcs/otsdaq_utilities/onlineDoc/inject_otsdaq_head.html
INJECT_SOURCE="otsdaq_utilities"
if [ $(basename $p) == "otsdaq" ]; then
INJECT_SOURCE="otsdaq"
fi

echo -e "./doxygen_main_editor $p/doc/html/index.html $OTS_SOURCE/otsdaq-utilities/onlineDoc/inject_${INJECT_SOURCE}.html $OTS_SOURCE/otsdaq-utilities/onlineDoc/inject_otsdaq_head.html"
# continue #for debugging
./doxygen_main_editor $p/doc/html/index.html $OTS_SOURCE/otsdaq-utilities/onlineDoc/inject_${INJECT_SOURCE}.html $OTS_SOURCE/otsdaq-utilities/onlineDoc/inject_otsdaq_head.html

if [ $ONLY_MAIN == 1 ]; then
echo -e "OnlineDocPushUpdate.sh:${LINENO} \t scp -r $p/doc/html/index.html ${OTS_WEB_USER}@${OTS_WEB_HOST}:/pubhosting/sites/o/otsdaq.fnal.gov/htdocs${SCP_LOC}/$(basename $p)/"
Expand All @@ -173,7 +185,7 @@ for p in ${REPO_DIR[@]}; do
scp -r $p/doc/html ${OTS_WEB_USER}@${OTS_WEB_HOST}:/pubhosting/sites/o/otsdaq.fnal.gov/htdocs${SCP_LOC}/$(basename $p)
echo -e "OnlineDocPushUpdate.sh:${LINENO} \t Done with .... scp -r $p/doc/html ${OTS_WEB_USER}@${OTS_WEB_HOST}:/pubhosting/sites/o/otsdaq.fnal.gov/htdocs${SCP_LOC}/$(basename $p)"

exit #for debugging
# exit #for debugging
fi
fi
done
Expand All @@ -188,6 +200,9 @@ echo -e "OnlineDocPushUpdate.sh:${LINENO} \t scp -r ${SCRIPT_DIR}/../onlineDoc/
scp -r ${SCRIPT_DIR}/../onlineDoc/otsdaq_doc_library.js ${OTS_WEB_USER}@${OTS_WEB_HOST}:/pubhosting/sites/o//otsdaq.fnal.gov/htdocs${SCP_LOC}/
echo -e "OnlineDocPushUpdate.sh:${LINENO} \t scp -r ${SCRIPT_DIR}/../onlineDoc/contentData ${OTS_WEB_USER}@${OTS_WEB_HOST}:/pubhosting/sites/o//otsdaq.fnal.gov/htdocs${SCP_LOC}/"
scp -r ${SCRIPT_DIR}/../onlineDoc/contentData ${OTS_WEB_USER}@${OTS_WEB_HOST}:/pubhosting/sites/o//otsdaq.fnal.gov/htdocs${SCP_LOC}/
echo -e "OnlineDocPushUpdate.sh:${LINENO} \t scp -r $OTS_SOURCE/otsdaq-utilities/onlineDoc/index.html ${OTS_WEB_USER}@${OTS_WEB_HOST}:/pubhosting/sites/o//otsdaq.fnal.gov/htdocs${SCP_LOC}/"
scp -r $OTS_SOURCE/otsdaq-utilities/onlineDoc/index.html ${OTS_WEB_USER}@${OTS_WEB_HOST}:/pubhosting/sites/o//otsdaq.fnal.gov/htdocs${SCP_LOC}/




Expand Down

0 comments on commit 83a0932

Please sign in to comment.