TEO Developer Manual

TEO Developer Manual @ roboticslab-uc3m

Currently hosted at https://robots.uc3m.es/teo-developer-manual/

If you have any doubts or comments

Please read the Developer Manual's Asking Questions section, and once you've succeded with its self-evaluation follow the recommendations by commenting publicly HERE if required

How-To's

• TEO Developer Manual
  • If you have any doubts or comments
  • How-To's
    • How to serve on localhost
    • How to upload changes to GitHub

How to serve on localhost

It is useful to serve on localhost to modify the website and see changes locally.

1. From the root of the project, run the following command:

   pip install -r requirements.txt
   mkdocs serve

2. You can now browse the site at the default location: http://127.0.0.1:8000

How to upload changes to GitHub

This project is managed as any project on GitHub. You may use Git or even the GitHub web interface, both on which you can find many tutorials online. The following points are specific to the MkDocs mechanism used:

1. Please do not upload the site/ folder. It is auto-generated locally, and the same should happen on the MkDocs servers.

2. It is safe to git push to any upstream branch, just remember that what is on master is what will be actually rendered as the website.