Skip to content

Commit

Permalink
[REFACT] documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
sarthou committed Dec 21, 2020
1 parent 84d6e9b commit 195d0ea
Show file tree
Hide file tree
Showing 14 changed files with 233 additions and 126 deletions.
16 changes: 8 additions & 8 deletions docs/Download.html
Original file line number Diff line number Diff line change
Expand Up @@ -57,15 +57,15 @@ <h3>Getting Start</h3>

<div class="contents">
<div id="contents-toggle" class=""></div>
<h3><a href="CppAPI.html">All C++ Classes</a></h3>
<h3><a href="cpp_API/CppAPI.html">All C++ Classes</a></h3>
<ul style="display: block;">
<li class="level1"><a href="ClientBase.html">ClientBase</a></li>
<li class="level1"><a href="Fact.html">Fact</a></li>
<li class="level1"><a href="ManagerClient.html">ManagerClient</a></li>
<li class="level1"><a href="OccasionsPublisher.html">OccasionsPublisher</a></li>
<li class="level1"><a href="OccasionsSubscriber.html">OccasionsSubscriber</a></li>
<li class="level1"><a href="TimelineManipulator.html">TimelineManipulator</a></li>
<li class="level1"><a href="TimelinesManipulator.html">TimelinesManipulator</a></li>
<li class="level1"><a href="cpp_API/ClientBase.html">ClientBase</a></li>
<li class="level1"><a href="cpp_API/Fact.html">Fact</a></li>
<li class="level1"><a href="cpp_API/ManagerClient.html">ManagerClient</a></li>
<li class="level1"><a href="cpp_API/OccasionsPublisher.html">OccasionsPublisher</a></li>
<li class="level1"><a href="cpp_API/OccasionsSubscriber.html">OccasionsSubscriber</a></li>
<li class="level1"><a href="cpp_API/TimelineManipulator.html">TimelineManipulator</a></li>
<li class="level1"><a href="cpp_API/TimelinesManipulator.html">TimelinesManipulator</a></li>
</ul>
</div>
</div>
Expand Down
26 changes: 14 additions & 12 deletions docs/InstallMementar.html
Original file line number Diff line number Diff line change
Expand Up @@ -57,15 +57,15 @@ <h3>Getting Start</h3>

<div class="contents">
<div id="contents-toggle" class=""></div>
<h3><a href="CppAPI.html">All C++ Classes</a></h3>
<h3><a href="cpp_API/CppAPI.html">All C++ Classes</a></h3>
<ul style="display: block;">
<li class="level1"><a href="ClientBase.html">ClientBase</a></li>
<li class="level1"><a href="Fact.html">Fact</a></li>
<li class="level1"><a href="ManagerClient.html">ManagerClient</a></li>
<li class="level1"><a href="OccasionsPublisher.html">OccasionsPublisher</a></li>
<li class="level1"><a href="OccasionsSubscriber.html">OccasionsSubscriber</a></li>
<li class="level1"><a href="TimelineManipulator.html">TimelineManipulator</a></li>
<li class="level1"><a href="TimelinesManipulator.html">TimelinesManipulator</a></li>
<li class="level1"><a href="cpp_API/ClientBase.html">ClientBase</a></li>
<li class="level1"><a href="cpp_API/Fact.html">Fact</a></li>
<li class="level1"><a href="cpp_API/ManagerClient.html">ManagerClient</a></li>
<li class="level1"><a href="cpp_API/OccasionsPublisher.html">OccasionsPublisher</a></li>
<li class="level1"><a href="cpp_API/OccasionsSubscriber.html">OccasionsSubscriber</a></li>
<li class="level1"><a href="cpp_API/TimelineManipulator.html">TimelineManipulator</a></li>
<li class="level1"><a href="cpp_API/TimelinesManipulator.html">TimelinesManipulator</a></li>
</ul>
</div>
</div>
Expand All @@ -74,9 +74,11 @@ <h3><a href="CppAPI.html">All C++ Classes</a></h3>
<h1 class="title">Install Mementar</h1>
<p>Since Mementar is a ROS package, make sure that ROS is installed on your platform. Mementar is fully supported and maintained by <a class="type" href="http://wiki.ros.org/kinetic/Installation">ROS Kinetic Kame</a> and <a class="type" href="http://wiki.ros.org/melodic/Installation">ROS Melodic Morenia</a>. Desktop ROS configuration is not required for use of mementar.</p>

<p>Mementar is strongly linked to the Ontologenius software to provide a semantic abstraction of the knowledge it stores.</p>

<p>Clone the package on your catkin workspace:</p>
<div class="code_block">
<p>cd ~/catkin_ws/src/</br></br>git clone https://github.com/sarthou/mementar.git</br></br>cd ..</br></br>catkin_make</p>
<p>cd ~/catkin_ws/src/</br>git clone https://github.com/sarthou/mementar.git</br>git clone https://github.com/sarthou/ontologenius.git</br>cd ..</br>catkin_make</p>
</div>

<h2>Troubles</h2>
Expand All @@ -88,14 +90,14 @@ <h2>Troubles</h2>
<div class="code_block">
<p>sudo apt-get install ros-DISTRO-qt-build</p>
</div>
<!--

<h2>Test Mementar installation</h2>
<p>Just run rostest to check if all the features work well on your platform:</p>
<div class="code_block">
<p>catkin_make run_tests_mementar_rostest</p>
</div>
<p class="tip">Some asynchronous mechanisms are used. A computer with little computing power can therefore affect some tests due to a slow response time.</p>
-->
<!--p class="tip">Some asynchronous mechanisms are used. A computer with little computing power can therefore affect some tests due to a slow response time.</p-->

<nav class="course-pagination">
<span class="course-pagination__separator"></span>
<a href="SetUp.html" class="course-pagination__btn">
Expand Down
16 changes: 8 additions & 8 deletions docs/SetUp.html
Original file line number Diff line number Diff line change
Expand Up @@ -57,15 +57,15 @@ <h3>Getting Start</h3>

<div class="contents">
<div id="contents-toggle" class=""></div>
<h3><a href="CppAPI.html">All C++ Classes</a></h3>
<h3><a href="cpp_API/CppAPI.html">All C++ Classes</a></h3>
<ul style="display: block;">
<li class="level1"><a href="ClientBase.html">ClientBase</a></li>
<li class="level1"><a href="Fact.html">Fact</a></li>
<li class="level1"><a href="ManagerClient.html">ManagerClient</a></li>
<li class="level1"><a href="OccasionsPublisher.html">OccasionsPublisher</a></li>
<li class="level1"><a href="OccasionsSubscriber.html">OccasionsSubscriber</a></li>
<li class="level1"><a href="TimelineManipulator.html">TimelineManipulator</a></li>
<li class="level1"><a href="TimelinesManipulator.html">TimelinesManipulator</a></li>
<li class="level1"><a href="cpp_API/ClientBase.html">ClientBase</a></li>
<li class="level1"><a href="cpp_API/Fact.html">Fact</a></li>
<li class="level1"><a href="cpp_API/ManagerClient.html">ManagerClient</a></li>
<li class="level1"><a href="cpp_API/OccasionsPublisher.html">OccasionsPublisher</a></li>
<li class="level1"><a href="cpp_API/OccasionsSubscriber.html">OccasionsSubscriber</a></li>
<li class="level1"><a href="cpp_API/TimelineManipulator.html">TimelineManipulator</a></li>
<li class="level1"><a href="cpp_API/TimelinesManipulator.html">TimelinesManipulator</a></li>
</ul>
</div>

Expand Down
99 changes: 99 additions & 0 deletions docs/Tutorials.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,99 @@
<html lang="en_US">

<head>
<title>Under Construction | Mementar 0.0.3</title>
<meta content="text/html; charset=utf-8" http-equiv="Content-Type">
<link href="style/mementar_api.css" rel="stylesheet" type="text/css">
<link href="img/logo/favicon.ico" rel="shortcut icon">
<link href="img/logo/favicon-32x32.png" rel="icon" type="image/png">
<link href="img/logo/favicon-16x16.png" rel="icon" type="image/png">
<link rel="stylesheet" href="https://use.fontawesome.com/releases/v5.6.3/css/all.css" integrity="sha384-UHRtZLI+pbxtHCWp1t77Bi1L4ZtiqrqD80Kn4Z8NTSRyMA2Fd33n5dQ8lWUE00s/" crossorigin="anonymous">
<script src="scripts/jquery-3.3.1.min.js"></script>
<script src="scripts/toggle.js" type="text/javascript"></script>
</head>

<body>
<div class="header" id="header">
<header class="fixed" id="navbar">
<div class="container">
<div class="navbar-header">
<div id="header-buttons">
<ul id="header-ul" data-event="hover_intent" data-effect="fade" data-effect-speed="500">
<li class="header-item"><a class="header-link" href="https://github.com/sarthou/mementar/wiki" tabindex="0">Wiki</a></li>
<li class="header-item"><a class="header-link" href="https://github.com/sarthou/mementar" tabindex="0"><img src="https://upload.wikimedia.org/wikipedia/commons/thumb/9/91/Octicons-mark-github.svg/1200px-Octicons-mark-github.svg.png" alt="github" width="40px" height="40px"/></a></li>
</ul>
</div>
<a class="navbar-icon" href="index.html">
<img src="img/logo/mementar.png " alt="mementar" width="65px" height="65px"/>
</a>
</div>
</div>
</header>
</div>

<div class="main">

<div class="navigationbar">
<ul class="sub-navigation">
<li><a href="https://github.com/sarthou/mementar/tree/master/src/API">C++ API sources</a></li>
<li><a href="https://github.com/sarthou/mementar/tree/master/include/mementar/API">C++ API headers</a></li>
<li><a href="https://gitlab.com/sarthou/mementar/pipelines">Pipelines</a></li>
</ul>
<h1>Mementar Documentation</h1>
<h2>Mementar 0.0.3</h2>
</div>

<div class="content">
<div class="sidebar" style="transition: all 0.2s ease-out 0s; top: -588px;">

<div class="contents">
<div id="contents-toggle" class=""></div>
<h3>Getting Start</h3>
<ul style="display: block;">
<li class="level1"><a href="Download.html">Download</a></li>
<li class="level1"><a href="InstallMementar.html">Install Mementar</a></li>
<li class="level1"><a href="SetUp.html">Set Up Your Environnement</a></li>
<li class="level1"><a href="Tutorials.html">Tutorials</a></li>
</ul>
</div>

<div class="contents">
<div id="contents-toggle" class=""></div>
<h3><a href="cpp_API/CppAPI.html">All C++ Classes</a></h3>
<ul style="display: block;">
<li class="level1"><a href="cpp_API/ClientBase.html">ClientBase</a></li>
<li class="level1"><a href="cpp_API/Fact.html">Fact</a></li>
<li class="level1"><a href="cpp_API/ManagerClient.html">ManagerClient</a></li>
<li class="level1"><a href="cpp_API/OccasionsPublisher.html">OccasionsPublisher</a></li>
<li class="level1"><a href="cpp_API/OccasionsSubscriber.html">OccasionsSubscriber</a></li>
<li class="level1"><a href="cpp_API/TimelineManipulator.html">TimelineManipulator</a></li>
<li class="level1"><a href="cpp_API/TimelinesManipulator.html">TimelinesManipulator</a></li>
</ul>
</div>
</div>

<div class="context">
<h1 class="title">Under Construction</h1>

<h2 align="center">Sorry, we're doing some work on the site</h2>
<img src="img/construction.png" width="100%">
<p align="center"><br>Thank you for being patient. We are doing our best to make this page available.</p>

</div>
</div>

</div>
</body>

<footer>
<div align="center">
<p>
Brought to you by:
<a class="laas_logo" href="https://www.laas.fr/public/">
<img src="img/LogoLAAS-2016_BW.png " alt="LAAS-CNRS" height="60px"/>
</a>
</p>
</div>
</footer>

</html>
16 changes: 8 additions & 8 deletions docs/construction.html
Original file line number Diff line number Diff line change
Expand Up @@ -59,15 +59,15 @@ <h3>Getting Start</h3>

<div class="contents">
<div id="contents-toggle" class=""></div>
<h3><a href="CppAPI.html">All C++ Classes</a></h3>
<h3><a href="cpp_API/CppAPI.html">All C++ Classes</a></h3>
<ul style="display: block;">
<li class="level1"><a href="ClientBase.html">ClientBase</a></li>
<li class="level1"><a href="Fact.html">Fact</a></li>
<li class="level1"><a href="ManagerClient.html">ManagerClient</a></li>
<li class="level1"><a href="OccasionsPublisher.html">OccasionsPublisher</a></li>
<li class="level1"><a href="OccasionsSubscriber.html">OccasionsSubscriber</a></li>
<li class="level1"><a href="TimelineManipulator.html">TimelineManipulator</a></li>
<li class="level1"><a href="TimelinesManipulator.html">TimelinesManipulator</a></li>
<li class="level1"><a href="cpp_API/ClientBase.html">ClientBase</a></li>
<li class="level1"><a href="cpp_API/Fact.html">Fact</a></li>
<li class="level1"><a href="cpp_API/ManagerClient.html">ManagerClient</a></li>
<li class="level1"><a href="cpp_API/OccasionsPublisher.html">OccasionsPublisher</a></li>
<li class="level1"><a href="cpp_API/OccasionsSubscriber.html">OccasionsSubscriber</a></li>
<li class="level1"><a href="cpp_API/TimelineManipulator.html">TimelineManipulator</a></li>
<li class="level1"><a href="cpp_API/TimelinesManipulator.html">TimelinesManipulator</a></li>
</ul>
</div>
</div>
Expand Down
22 changes: 11 additions & 11 deletions docs/ClientBase.html → docs/cpp_API/ClientBase.html
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,10 @@
<head>
<title>ClientBase Class | Mementar 0.0.3</title>
<meta content="text/html; charset=utf-8" http-equiv="Content-Type">
<link href="style/mementar_api.css" rel="stylesheet" type="text/css">
<link href="img/logo/favicon.ico" rel="shortcut icon">
<link href="img/logo/favicon-32x32.png" rel="icon" type="image/png">
<link href="img/logo/favicon-16x16.png" rel="icon" type="image/png">
<link href="../style/mementar_api.css" rel="stylesheet" type="text/css">
<link href="../img/logo/favicon.ico" rel="shortcut icon">
<link href="../img/logo/favicon-32x32.png" rel="icon" type="image/png">
<link href="../img/logo/favicon-16x16.png" rel="icon" type="image/png">
</head>

<body>
Expand All @@ -20,8 +20,8 @@
<li class="header-item"><a class="header-link" href="https://github.com/sarthou/mementar" tabindex="0"><img src="https://upload.wikimedia.org/wikipedia/commons/thumb/9/91/Octicons-mark-github.svg/1200px-Octicons-mark-github.svg.png" alt="github" width="40px" height="40px"/></a></li>
</ul>
</div>
<a class="navbar-icon" href="index.html">
<img src="img/logo/mementar.png " alt="mementar" width="65px" height="65px"/>
<a class="navbar-icon" href="../index.html">
<img src="../img/logo/mementar.png " alt="mementar" width="65px" height="65px"/>
</a>
</div>
</div>
Expand Down Expand Up @@ -57,10 +57,10 @@ <h3>Contents</h3>
<div id="contents-toggle" class=""></div>
<h3>Getting Start</h3>
<ul style="display: block;">
<li class="level1"><a href="Download.html">Download</a></li>
<li class="level1"><a href="InstallMementar.html">Install Mementar</a></li>
<li class="level1"><a href="SetUp.html">Set Up Your Environnement</a></li>
<li class="level1"><a href="Tutorials.html">Tutorials</a></li>
<li class="level1"><a href="../Download.html">Download</a></li>
<li class="level1"><a href="../InstallMementar.html">Install Mementar</a></li>
<li class="level1"><a href="../SetUp.html">Set Up Your Environnement</a></li>
<li class="level1"><a href="../Tutorials.html">Tutorials</a></li>
</ul>
</div>

Expand Down Expand Up @@ -160,7 +160,7 @@ <h3 class="fn" id="callNR"><a name="callNR"></a>inline <span class="type">bool</
<p>
Brought to you by:
<a class="laas_logo" href="https://www.laas.fr/public/">
<img src="img/LogoLAAS-2016_BW.png " alt="LAAS-CNRS" height="60px"/>
<img src="../img/LogoLAAS-2016_BW.png " alt="LAAS-CNRS" height="60px"/>
</a>
</p>
</div>
Expand Down
22 changes: 11 additions & 11 deletions docs/CppAPI.html → docs/cpp_API/CppAPI.html
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,10 @@
<head>
<title>C++ API | Mementar 0.0.3</title>
<meta content="text/html; charset=utf-8" http-equiv="Content-Type">
<link href="style/mementar_api.css" rel="stylesheet" type="text/css">
<link href="img/logo/favicon.ico" rel="shortcut icon">
<link href="img/logo/favicon-32x32.png" rel="icon" type="image/png">
<link href="img/logo/favicon-16x16.png" rel="icon" type="image/png">
<link href="../style/mementar_api.css" rel="stylesheet" type="text/css">
<link href="../img/logo/favicon.ico" rel="shortcut icon">
<link href="../img/logo/favicon-32x32.png" rel="icon" type="image/png">
<link href="../img/logo/favicon-16x16.png" rel="icon" type="image/png">
<link rel="stylesheet" href="https://use.fontawesome.com/releases/v5.6.3/css/all.css" integrity="sha384-UHRtZLI+pbxtHCWp1t77Bi1L4ZtiqrqD80Kn4Z8NTSRyMA2Fd33n5dQ8lWUE00s/" crossorigin="anonymous">
</head>

Expand All @@ -21,8 +21,8 @@
<li class="header-item"><a class="header-link" href="https://github.com/sarthou/mementar" tabindex="0"><img src="https://upload.wikimedia.org/wikipedia/commons/thumb/9/91/Octicons-mark-github.svg/1200px-Octicons-mark-github.svg.png" alt="github" width="40px" height="40px"/></a></li>
</ul>
</div>
<a class="navbar-icon" href="index.html">
<img src="img/logo/mementar.png " alt="mementar" width="65px" height="65px"/>
<a class="navbar-icon" href="../index.html">
<img src="../img/logo/mementar.png " alt="mementar" width="65px" height="65px"/>
</a>
</div>
</div>
Expand All @@ -48,10 +48,10 @@ <h2>Mementar 0.0.3</h2>
<div id="contents-toggle" class=""></div>
<h3>Getting Start</h3>
<ul style="display: block;">
<li class="level1"><a href="Download.html">Download</a></li>
<li class="level1"><a href="InstallMementar.html">Install Mementar</a></li>
<li class="level1"><a href="SetUp.html">Set Up Your Environnement</a></li>
<li class="level1"><a href="Tutorials.html">Tutorials</a></li>
<li class="level1"><a href="../Download.html">Download</a></li>
<li class="level1"><a href="../InstallMementar.html">Install Mementar</a></li>
<li class="level1"><a href="../SetUp.html">Set Up Your Environnement</a></li>
<li class="level1"><a href="../Tutorials.html">Tutorials</a></li>
</ul>
</div>

Expand Down Expand Up @@ -99,7 +99,7 @@ <h3><a href="TimelinesManipulator.html"><b>TimelinesManipulator</b></a></h3>
<p>
Brought to you by:
<a class="laas_logo" href="https://www.laas.fr/public/">
<img src="img/LogoLAAS-2016_BW.png " alt="LAAS-CNRS" height="60px"/>
<img src="../img/LogoLAAS-2016_BW.png " alt="LAAS-CNRS" height="60px"/>
</a>
</p>
</div>
Expand Down
Loading

0 comments on commit 195d0ea

Please sign in to comment.