README.md

iCub Tech Docs

🌐 Browse our online documentation.

This is an attempt to make available to the community useful information that are not present or easily accessible through our official documentation. Thus, at the time being, it is intended to be an ever-growing container that supports and integrates with the official resources.

📝 Importantly, you can contribute to these docs by fixing typos and proposing new additions (see below).

Contributing

Check out our CONTRIBUTING guidelines.

👨🏻‍💻 Maintainers

This repository is maintained by:

	@pattacini

☁ Cloud Workflow

You can leverage on the following Cloud IDE's to quickly get a testing platform where to try out how the documentation is rendered.

🔘 Gitpod

First off, sign up for Gitpod using your GitHub credentials. You'll have 50 hours/month of free usage on public repositories. Also, remember to visit the Gitpod Integrations to make sure that all GitHub options are ticked in.

Then, install the Gitpod browser extension.

Click to enlarge

🔘 GitHub Codespaces (if available)

Click to enlarge

🔘 GitHub Pages on Forks

We use GitHub Actions to publish the website on the GitHub Pages. However, GitHub Actions are disabled by default on forks. Thus, follow the steps below, where you have to correctly fill up the signature your-fork:

• Browse to https://github.com/your-fork/documentation/actions and enable the actions.
• Browse to https://github.com/your-fork/documentation/actions/workflows/gh-pages.yml and click on the Run workflow button.
• Browse to https://github.com/your-fork/documentation/settings/pages, select the gh-pages branch and wait until the GitHub Pages link becomes green to click on!

🔽 Local Workflow

💻 Install the environment yourself

If you prefer to work on the documentation on your own computer without using Cloud IDEs as described in the previous section, you need to install the following software packages:

• mkdocs
• mkdocs-material
• mkdocs-material-extensions
• PyMdown Extensions

Once you have installed them, just clone this repo, navigate to it and serve its content with the mkdocs serve command:

git clone https://github.com/icub-tech-iit/documentation
cd documentation
mkdocs serve

📦 Rely on package managers

In the next sections, we will describe in detail how to install the required dependencies using different package managers.

🐍 conda

You can use the conda-forge distribution to install the required dependencies on Linux, macOS or Windows. First of all you need a conda distribution, for example Miniforge3.

If you already have a conda distribution, just create a new environment (for example called mkdocs-env) and install in it the require dependencies:

conda create -n mkdocs-env
conda activate mkdocs-env
conda install --channel conda-forge mkdocs-material mkdocs-material-extensions pymdown-extensions

After the installation, whenever you need to test the website just activate the mkdocs-env environment and call mkdocs serve in the documentation directory:

cd documentation
conda activate mkdocs-env
mkdocs serve