https://github.com/stack-of-tasks/sot-doc

Doxygen based documentation for the stack-of-tasks organization
https://github.com/stack-of-tasks/sot-doc

control documentation stack-of-tasks

Last synced: about 1 year ago
JSON representation

Doxygen based documentation for the stack-of-tasks organization

• Host: GitHub
• URL: https://github.com/stack-of-tasks/sot-doc
• Owner: stack-of-tasks
• License: mit
• Created: 2020-02-24T08:06:17.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2022-09-14T10:10:27.000Z (almost 4 years ago)
• Last Synced: 2025-03-30T02:11:06.360Z (about 1 year ago)
• Topics: control, documentation, stack-of-tasks
• Language: Shell
• Homepage: https://stack-of-tasks.github.io/sot-doc/doxygen/HEAD/index.html
• Size: 1.45 MB
• Stars: 1
• Watchers: 6
• Forks: 6
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# sot-doc

[![Pipeline status](https://gitlab.laas.fr/stack-of-tasks/sot-doc/badges/master/pipeline.svg)](https://gitlab.laas.fr/stack-of-tasks/sot-doc/commits/master)

[![Coverage report](https://gitlab.laas.fr/stack-of-tasks/sot-doc/badges/master/coverage.svg?job=doc-coverage)](http://projects.laas.fr/gepetto/doc/stack-of-tasks/sot-doc/master/coverage/)

This repository contains the entrypoint of the LAAS stack-of-tasks implementation.

It is based on doxygen.

## Dependencies

This package depends on doxygen, cmake and git.

## How to contribute

Please follow the structure given in doc.

The entry point is Doxyfile.extra.in

If you add a new file, please add the file in the entry

INPUT.

Pictures for the documentation should be added in the directory

    ./doc/pictures

as specified by the variable IMAGE_PATH

Script and configuration file for the installation and the setup of the Stack-Of-Tasks are provided in the directory bash.

Apart setup-sot.sh when you install through robotpkg.sh the files are only

used when you want to develop.

## Generate locally the documentation

To generate the documentation please follow the instructions:

    mkdir build

    cd build

    cmake ..

    make doc

To read the produced documentation :

    firefox ./doc/doxygen-html/index.html

## Updating sot-doc github webpage

The sot-doc github webpage can be update through:

    ./cmake/github/update-doxygen-doc.sh -r $PWD -b $PWD/build