Keep the documentation updated (#209)

.github/workflows/gh-pages.yml

@@ -4,6 +4,9 @@ on:
   push:
     branches:
     - 'master'
+  pull_request:
+    branches:
+      - 'master'
 
 jobs:
   docs:

doc/mkdocs/docs/ergocubemotions.md

@@ -0,0 +1 @@
+--8<-- "src/modules/ergoCubEmotions/README.md"

doc/mkdocs/docs/index.md

@@ -1,59 +1 @@
-# ergoCub Software
-
-Main collector of ergoCub specific SW
-
-## Installation
-
-For installing it just:
-
-```sh
-mkdir build
-cd build
-cmake -DCMAKE_INSTALL_PREFIX=<install-prefix> ..
-make
-(make install)
-```
-
-`ergocub` model needs [Gazebo YARP Plugins v4.6.0](https://github.com/robotology/gazebo-yarp-plugins/releases/tag/v4.6.0) or higher in order to be used.
-
-In order to use the model, the following env variables must be configured:
-
-```sh
-# ergoCub model in YARP
-export YARP_DATA_DIRS=${YARP_DATA_DIRS}:<install-prefix>/share/ergoCub
-# ergoCub model in Gazebo
-export GAZEBO_MODEL_PATH=${GAZEBO_MODEL_PATH}:<install-prefix>/share/ergoCub/robots
-export GAZEBO_MODEL_PATH=${GAZEBO_MODEL_PATH}:<install-prefix>/share/
-```
-
-## Run Whole-body-dynamics
-
-Currently whole-body-dynamics does not run along with `ergoCubGazeboV1`. To start it please run the following command in a console once `yarpserver` and
-the robot has been placed in `gazebo`
-
-```console
-yarprobotinterface --config conf/launch_wholebodydynamics_ecub.xml
-```
-
-## URDF generation
-
-This repo hosts the `ergoCub` urdf, enabling the cmake flag `ERGOCUB_MODEL_GENERATE_SIMMECHANICS` it is possible to generate it from simmechanics xml.
-Enabling also `ERGOCUB_MODEL_COPY_TO_SRC` the generated models are copied in the `urdf` directory for being committed.
-
-### Dependencies
-
-- [Ruby](https://www.ruby-lang.org/en/)
-- [iDynTree](https://github.com/robotology/idyntree)
-- [YARP](https://github.com/robotology/yarp)
-- [simmechanics-to-urdf](https://github.com/robotology/simmechanics-to-urdf)
-
-### Usage
-
-```sh
-mkdir build
-cd build
-cmake -DERGOCUB_MODEL_GENERATE_SIMMECHANICS=BOOL:ON -DERGOCUB_MODEL_COPY_TO_SRC=BOOL:ON ..
-make
-(make install)
-```
-
+--8<-- "README.md"

doc/mkdocs/docs/modules_intro.md

@@ -2,4 +2,4 @@
 
 These are the modules currently available:
 
-- [ergoCubEmotions](ergoCubEmotions.md)
+- [ergoCubEmotions](ergocubemotions.md)

doc/mkdocs/site-compile.sh

@@ -1,3 +1,4 @@
 #!/bin/bash
 
-mkdocs build -c -v --site-dir site
+cd ../../
+mkdocs build -c -v --site-dir doc/mkdocs/site

doc/mkdocs/mkdocs.yml → mkdocs.yml

@@ -7,6 +7,7 @@ copyright: BSD 3-Clause License
 repo_name: icub-tech-iit/ergocub-software
 repo_url: https://github.com/icub-tech-iit/ergocub-software/
 edit_uri: 'edit/master/doc/mkdocs/docs'
+docs_dir: 'doc/mkdocs/docs'
 
 markdown_extensions:
   - attr_list
@@ -17,6 +18,7 @@ markdown_extensions:
   - pymdownx.caret
   - pymdownx.critic
   - pymdownx.details
+  - pymdownx.snippets
   - pymdownx.inlinehilite
   - pymdownx.highlight
   - pymdownx.keys
@@ -96,4 +98,4 @@ nav:
     - Documentation: https://icub-tech-iit.github.io/ergocub-software/doc/doxygen/doc/html/index.html
     - Modules:
         - Getting started: 'modules_intro.md'
-        - ergoCubEmotions: 'ergoCubEmotions.md'
+        - ergoCubEmotions: 'ergocubemotions.md'