Developer Manual @ roboticslab-uc3m
Currently hosted at https://robots.uc3m.es/developer-manual/
Please read the Asking Questions section, and once you've succeded with its self-evaluation follow the recommendations by commenting publicly HERE if required
It is useful to serve on localhost to modify the website and see changes locally.
-
From the root of the project, run the following command:
pip install -r requirements.txt mkdocs serve
-
You can now browse the site at the default location: http://127.0.0.1:8000
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:
-
Please do not upload the
site/folder. It is auto-generated locally, and the same should happen on the MkDocs servers. -
It is safe to
git pushto any upstream branch, just remember that what is onmasteris what will be actually rendered as the website.