This repository contains the content of https://robotcomponents.github.io/RobotComponents-API-Documentation/index.html. The API documentation page is built with DocFX.
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.
We generate the API documentation with docfx. The files are compiled and pushed manually. To update the docs, follow the next steps:
- Install docfx. You can find more information and the steps here.
- Pull the files from this repo via git.
- Update/replace the
.dlland.xmlfiles in thesrcfolder. - Use the command prompt and navigate to the folder of this repo.
- Build the new documentation pages by calling the command
docfx build. - Push the updated files.
Copyright (c) 2018-2020 EDEK Uni Kassel
Copyright (c) 2020-2024 Arjen Deetman
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.
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.
You should have received a copy of the GNU General Public License along with Robot Components; If not, see http://www.gnu.org/licenses/.
@license GPL-3.0 https://www.gnu.org/licenses/gpl-3.0.html