-
Notifications
You must be signed in to change notification settings - Fork 0
MARS-Group-HAW/mars-docfx
Folders and files
| Name | Name | Last commit message | Last commit date | |
|---|---|---|---|---|
Repository files navigation
<!DOCTYPE html>
<!--[if IE]><![endif]-->
<html>
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
<title>MARS Documentation | Website | MARS LIFE Runtime System </title>
<meta name="viewport" content="width=device-width">
<meta name="title" content="MARS Documentation | Website | MARS LIFE Runtime System ">
<meta name="generator" content="docfx ">
<link rel="shortcut icon" href="images/mars/mars-icon.ico">
<link rel="stylesheet" href="styles/docfx.vendor.css">
<link rel="stylesheet" href="styles/docfx.css">
<link rel="stylesheet" href="styles/main.css">
<link href="https://fonts.googleapis.com/css?family=Roboto" rel="stylesheet">
<meta property="docfx:navrel" content="toc.html">
<meta property="docfx:tocrel" content="toc.html">
<meta property="docfx:rel" content="">
</head> <body data-spy="scroll" data-target="#affix" data-offset="120">
<div id="wrapper">
<header>
<nav id="autocollapse" class="navbar navbar-inverse ng-scope" role="navigation">
<div class="container">
<div class="navbar-header">
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<a class="navbar-brand" href="index.html">
<img id="logo" class="svg" src="images/mars/mars-icon-resized.png" alt="">
</a>
</div>
<div class="collapse navbar-collapse" id="navbar">
<form class="navbar-form navbar-right" role="search" id="search">
<div class="form-group">
<input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">
</div>
</form>
<ul class="nav level1 navbar-nav">
<li>
<a href="articles/about_mars.html" title="Documentation">Documentation</a>
</li>
<li>
<a href="simulation/Mars.Core.html" title="Core API">Core API</a>
</li>
<li>
<a href="soh/SOHBicycleModel.Common.html" title="SmartOpenHamburg API">SmartOpenHamburg API</a>
</li>
<li>
<a href="components/Mars.Components.html" title="Model Components API">Model Components API</a>
</li>
<li>
<a href="common/Mars.Common.html" title="Common API">Common API</a>
</li>
</ul> </div>
</div>
</nav>
<div class="subnav navbar navbar-default">
<div class="container hide-when-search" id="breadcrumb">
<ul class="breadcrumb">
<li></li>
</ul>
</div>
</div>
</header>
<div class="container body-content">
<div id="search-results">
<div class="search-list">Search Results for <span></span></div>
<div class="sr-items">
<p><i class="glyphicon glyphicon-refresh index-loading"></i></p>
</div>
<ul id="pagination" data-first="First" data-prev="Previous" data-next="Next" data-last="Last"></ul>
</div>
</div>
<div role="main" class="container body-content hide-when-search">
<div class="article row grid">
<div class="col-md-10">
<article class="content wrap" id="_content" data-uid="">
<h1 align="center">MARS Documentation | <a href="https://mars.haw-hamburg.de">Website</a></h1>
<p>The whole documentation shall be generated after every update and is available at <a href="http://mars.haw-hamburg.de/">http://mars.haw-hamburg.de/</a></p>
<h2 id="prerequisites">Prerequisites</h2>
<p>For code documentation, we use the metadata tool the documentation tool <code>docfx</code>. Make sure you have installed the followin prerequisites on your local development machine</p>
<ul>
<li><strong>docfx</strong> -
For MacOS it is important that you have install only the version <code>2.51</code>, since newer version seems to have problems with <code>netstandard2.0</code> project like MARS. The the required version can be downloaded from <a href="https://github.com/dotnet/docfx/releases/tag/v2.51">here</a> is available here <a href=""></a>. All other please follow the <a href="https://dotnet.github.io/docfx/tutorial/docfx_getting_started.html">Getting started</a> page.</li>
</ul>
<p>For making changes on the website.</p>
<ul>
<li><a href="https://dotnet.github.io/docfx/tutorial/docfx_getting_started.html#2-use-docfx-as-a-command-line-tool">docfx</a> to create the documentation web-content from markdown and C# API.</li>
<li><a href="https://docs.docker.com/get-docker/">Docker</a> platform to create a local and global deployment.</li>
<li><a href="https://kubernetes.io/de/docs/tasks/tools/install-kubectl/">kubectl</a> to serve the local deployment and to apply change for the cluster. </li>
</ul>
<h2 id="build-via-script">Build via Script</h2>
<p>The existing <code>build.sh</code> script contains all required commands to build a local Docker image of the current documentation and upload it to the remote Docker Hub.</p>
<p>By default each image is tagged with a successing version number. Apply this version to the <code>build.sh</code> call.
Therefore change into the working directory of <code>Documentation</code> (when not already changed).</p>
<pre><code class="lang-shell">cd Documentation
</code></pre><pre><code class="lang-shell">./build.sh <version-number>
</code></pre><p>The version number can be queried by asking the current deployment at the cluster or looking at the latest version in the repo <a href="https://git.haw-hamburg.de:5005/mars/life/">git.haw-hamburg.de:5005/mars/life/</a></p>
<blockquote><p>When the <code>build.sh</code> script cannot be exeucted directly apply execution rights before <code>chmod +x ./build.sh</code></p>
</blockquote>
<h2 id="build-with-docfx">Build with DocfX</h2>
<p>Use the pre-defined configuration <code>docfx.json</code> and run:</p>
<pre><code class="lang-bash">docfx docfx.json --serve
</code></pre><p>When <code>docfx</code> is an <code>exe</code> file and your local machine is linux or macOS, please use <a href="https://www.mono-project.com/download/stable/">mono</a></p>
<pre><code class="lang-bash">mono docfx.exe docfx.json --serve
</code></pre><p>This will generate the website and starts a <strong>local</strong> webserver for to show your results.</p>
<h2 id="custom-tutorials-or-articles">Custom Tutorials or Articles</h2>
<p>To write your own tutorials and other useful articles, how to use MARS. Create a new markdown file and your write your contente therein. Move your article into the folder <code>articles</code> folder and link it by using the <code>toc.yml</code> (table of content) or by inserting the link into the <code>into.md</code> page at <strong>articles/intro.md</strong>. </p>
</article>
</div>
<div class="hidden-sm col-md-2" role="complementary">
<div class="sideaffix">
<div class="contribution">
<ul class="nav">
<li>
<a href="https://github.com/MARS-Group-HAW/life/blob/main/Documentation/README.md/#L1" class="contribution-link">Improve this Doc</a>
</li>
</ul>
</div>
<nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
<h5>In This Article</h5>
<div></div>
</nav>
</div>
</div>
</div>
</div>
<footer>
<div class="grad-bottom"></div>
<div class="footer">
<div class="container">
<span class="pull-right">
<a href="#top">Back to top</a>
</span>
<span>Copyright © MARS GROUP.<br><strong>HAW Hamburg</strong></span>
</div>
</div>
</footer>
</div>
<script type="text/javascript" src="styles/docfx.vendor.js"></script>
<script type="text/javascript" src="styles/docfx.js"></script>
<script type="text/javascript" src="styles/main.js"></script>
</body>
</html>
About
No description, website, or topics provided.
Resources
Stars
Watchers
Forks
Releases
No releases published
Packages 0
No packages published