Skip to content
Branch: master
Find file History
Pull request Compare This branch is 52 commits ahead, 797 commits behind revision.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
..
Failed to load latest commit information.
automobile
blog
css
guide
js
reference
src
tests
.gitignore
README.md
dependencies.txt
dependencies_fallback.txt
doc.php
generate_thumbnails.py
index.template.html
local_dependencies.txt
local_exporter.py

README.md

webots-doc

This repository contains the documentation of the Webots software.

The master branch of this repository is in production on the Cyberbotics website:

You are very welcome to contribute to make this documentation better! In order to proceed, simply fork this repository, make your modifications and open a pull request that we will review and merge.

To view a specific version

You can display the documentation corresponding to a specific version of Webots by using the version argument in the URL, for example:

https://www.cyberbotics.com/doc/guide/index?version=8.5

This version argument corresponds to a git tag on this repository.

Alternatively, it is possible to display the documentation corresponding to a github branch of this repository:

https://www.cyberbotics.com/doc/guide/index?version=master

Or to a github branch (e.g. reference_proto) of any public github repository (e.g. remidhum):

https://www.cyberbotics.com/doc/guide/index?version=remidhum:reference_proto

Run the doc locally

Set the terminal to the 'docs' directory.

cd $WEBOTS_HOME/docs

Create or update the index.html page:

python local_exporter.py

Run a simple HTTP server:

python -m SimpleHTTPServer

In a browser, open:

Run the unit tests

Install the pep8 module:

sudo apt-get install python-pip
pip install pep8

Run the tests:

cd $WEBOTS_HOME/docs
python -m unittest discover
You can’t perform that action at this time.