docs
Folders and files
| Name | Name | Last commit date | ||
|---|---|---|---|---|
parent directory.. | ||||
<!DOCTYPE html>
<!--[if IE]><![endif]-->
<html>
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
<title>Robot Components API Documentation </title>
<meta name="viewport" content="width=device-width">
<meta name="title" content="Robot Components API Documentation ">
<link rel="shortcut icon" href="favicon.ico">
<link rel="stylesheet" href="styles/docfx.vendor.min.css">
<link rel="stylesheet" href="styles/docfx.css">
<link rel="stylesheet" href="styles/main.css">
<meta property="docfx:navrel" content="toc.html">
<meta property="docfx:tocrel" content="toc.html">
</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="logo.svg" 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>
</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 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 id="robot-components-api-documentation">Robot Components API Documentation</h1>
<p><a href=""><img src="https://img.shields.io/github/license/RobotComponents/RobotComponents-API-Documentation" alt="License"></a>
<a href="https://doi.org/10.5281/zenodo.5773814"><img src="https://zenodo.org/badge/DOI/10.5281/zenodo.5773814.svg" alt="DOI"></a></p>
<p>This repository contains the content of <a href="https://robotcomponents.github.io/RobotComponents-API-Documentation/index.html">https://robotcomponents.github.io/RobotComponents-API-Documentation/index.html</a>. The API documentation page is built with <a href="https://dotnet.github.io/docfx/">DocFX</a>.</p>
<p>Pull requests are welcome. If you want to build the site yourself, to test your changes before opening a pull request, then please check out the getting started guide below.</p>
<h2 id="getting-started">Getting started</h2>
<p>We generate the API documentation with <a href="https://dotnet.github.io/docfx/">docfx</a>. The files are compiled and pushed manually. To update the docs, follow the next steps:</p>
<ol>
<li>Install docfx. You can find more information and the steps <a href="https://dotnet.github.io/docfx/tutorial/walkthrough/walkthrough_create_a_docfx_project.html">here</a>.</li>
<li>Pull the files from this repo via git.</li>
<li>Update/replace the <code>.dll</code> and <code>.xml</code> files in the <code>src</code> folder.</li>
<li>Use the command prompt and navigate to the folder of this repo.</li>
<li>Build the new documentation pages by calling the command <code>docfx build</code>.</li>
<li>Push the updated files.</li>
</ol>
<h2 id="license">License</h2>
<p>Copyright (c) 2018-2024 <a href="https://github.com/RobotComponents/RobotComponents/blob/master/AUTHORS.md">The Robot Components authors and/or their affiliations</a></p>
<p>Robot Components is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License version 3.0 as published by the Free Software Foundation.</p>
<p>Robot Components is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.</p>
<p>You should have received a copy of the GNU General Public License along with Robot Components; If not, see <a href="http://www.gnu.org/licenses/">http://www.gnu.org/licenses/</a>.</p>
<p>@license GPL-3.0 <a href="https://www.gnu.org/licenses/gpl-3.0.html">https://www.gnu.org/licenses/gpl-3.0.html</a></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/RobotComponents/RobotComponents-API-Documentation/blob/master/README.md/#L1" class="contribution-link">Edit this page</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>Generated by <strong>DocFX</strong></span>
</div>
</div>
</footer>
</div>
<script type="text/javascript" src="styles/docfx.vendor.min.js"></script>
<script type="text/javascript" src="styles/docfx.js"></script>
<script type="text/javascript" src="styles/main.js"></script>
</body>
</html>
