refactored for publishing

.github/workflows/gh-pages.yml

@@ -0,0 +1,44 @@
+name: GitHub Pages
+
+on:
+  push:
+    branches:
+    - 'master'
+
+jobs:
+  docs:
+    name: "Deploy"
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@master
+      - name: Dependencies
+        run: |
+          sudo apt update
+          sudo apt install -y python3-wheel python3-setuptools
+          pip3 install --user mkdocs mkdocs-material pymdown-extensions
+          echo "::set-env name=PATH::${HOME}/.local/bin:$PATH"
+        
+      - name: Configure Git
+        run: |
+          git config --global push.default upstream
+          git config --global user.name "GitHub Actions"
+          git config --global user.email "[email protected]"
+          git remote set-url origin https://x-access-token:${{ secrets.GITHUB_TOKEN }}@github.com/${{ github.repository }}.git
+
+      - name: Build Mkdocs
+        run: |
+          mkdocs build
+
+      - name: Create and prepare gh-pages anew
+        run: |
+          git checkout --orphan gh-pages
+          rm -R `ls -A | grep -v -E "^(.git|site)$"`
+          mv site/* ./
+          rm -Rf site
+
+      - name: Commit and push
+        run: |
+          git add .
+          git commit -m "publish site"
+          git push --force --set-upstream origin gh-pages

.gitignore

@@ -0,0 +1 @@
+site

LICENSE

@@ -0,0 +1,29 @@
+BSD 3-Clause License
+
+Copyright (c) 2020, iCub Tech
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its
+   contributors may be used to endorse or promote products derived from
+   this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

README.md

@@ -1,13 +1,4 @@
-# mkdocs tests
-This repository contains tests for mkdocs.
-
-see https://icub-tech-iit.github.io/documentation/mkdocs/thedocs/site
-
-and: https://github.com/icub-tech-iit/documentation/wiki
-
-
-
-
-
-
+iCub Tech Docs
+==============
 
+Browse our [online documentation 🌐](https://icub-tech-iit.github.io/documentation).

docs/icub.md

@@ -0,0 +1,28 @@
+<div style="position:fixed;top:140px;left:85%;">
+    <img src="../assets/icub-rotate.gif" width="60%" height="60%">
+</div>
+
+# iCub Documentation
+First draft of iCub documentation.
+
+## iCub Tendons
+[iCub Tendons](./icub_tendons/index.md) contains a technical description of the tendons of the iCub, comprising how to assemble the steel cables and how to change broken parts. 
+
+## The Upgrade Kits
+The design of our robot evolves in time. We have been asking ourselves how to propagate the mechanical or hardare enhancements we design to older robots. Our solution is to define upgrade kits that can be applied to specific robots. 
+
+An upgrade kit is a ... plastic bag with mechanical parts, hardware boards, screws, wires, tendons and whatever it is required to perform a physical upgrade of the robots. And surely the instructions.
+
+Here are our first kits:
+
+### iCub Upgrade Kit: hand
+[iCub Hands Support UpKit](./upgrade_kits/hands/support.md) describes how to perform an upgrade to the hands of iCub. The upgrade consists of replacing the supports of the mais board and on a new cover.
+
+### iCub Upgrade Kit: eyes support 
+[iCub Eyes Support UpKit](./upgrade_kits/eyes/support.md) describes how to perform an upgrade to iCub so that the supports of the eyes make them more stable.
+
+### iCub Upgrade Kit: torso capacitors 
+[iCub Torso Capacitors UpKit](./upgrade_kits/eyes/support.md) describes how to perform an upgrade to iCub so that the capacitors placed in its back don't get loose.
+
+### iCub Upgrade Kit: differential neck pulley 
+[iCub Differential Neck Pulley UpKit](./upgrade_kits/eyes/support.md) describes how to perform an upgrade of the neck of iCub so that the tendon does not easily slip away.

mkdocs/tendons_icub/docs/cabling_V2.md → docs/icub_tendons/cabling_V2.md

@@ -6,7 +6,7 @@
 
 | Left Forearm V2   | Right Forearm V2 |
 | ----------------- | ---------------- |
-| <img src ="../GIF/lower_arm/L-4RM-V2.gif" height = 600px>    | <img src ="../GIF/lower_arm/R-4RM-V2.gif" height = 600px>    |
+| <img src ="../gif/lower_arm/L-4RM-V2.gif" height = 600px>    | <img src ="../gif/lower_arm/R-4RM-V2.gif" height = 600px>    |
 | in **CAD** repository (maybe CREO): RC_TLR_007_A_001_LEFT_FOREARM.ASM + RC_TLR_012_A_001_LEFT_HAND.ASM | in **CAD** repository (maybe CREO): RC_TLR_010_A_001_RIGHT_FOREARM.ASM + RC_TLR_011_A_001_RIGHT_HAND.ASM |
 
 ## 1	WHAT DO I NEED TO CABLE

mkdocs/tendons_icub/docs/hand_cabling_V1.md → docs/icub_tendons/hand_cabling_V1.md

@@ -8,7 +8,7 @@
 
 | Left Forearm V1                                           | Right Forearm V1                                          |
 | --------------------------------------------------------- | --------------------------------------------------------- |
-| <img src ="../GIF/lower_arm/L-4RM-V1.gif" height = 600px> | <img src ="../GIF/lower_arm/R-4RM-V1.gif" height = 600px> |
+| <img src ="../gif/lower_arm/L-4RM-V1.gif" height = 600px> | <img src ="../gif/lower_arm/R-4RM-V1.gif" height = 600px> |
 
 ## 1 Basic Principles