# webots_docs

**Repository Path**: starllv/webots_docs

## Basic Information

- **Project Name**: webots_docs
- **Description**: webots官方文档
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 3
- **Created**: 2023-10-28
- **Last Updated**: 2023-10-28

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Webots Documentation

>只供学习交流使用，Chrome浏览器右键可以将英译汉/汉译英<br>
>For learning and communication only, right click on Chrome to translate from Chinese 2 English or English 2 Chinese

## 1. 用户手册目录（Menu of User Guide ）
&emsp;&emsp;请点击:[**User Guide.md**](https://gitee.com/spr-robotics-club/webots_docs/blob/master/guide/menu.md)
  
## 2. 参考资料目录（Menu of Reference）
&emsp;&emsp;请点击:[**Reference.md**](https://gitee.com/spr-robotics-club/webots_docs/blob/master/reference/menu.md)

This repository contains the documentation for the Webots open source simulation software.

The released branch of this repository is in production on the Cyberbotics website, which you can access by visiting the following links:

- https://www.cyberbotics.com/doc/guide/index
- https://www.cyberbotics.com/doc/reference/index
- https://www.cyberbotics.com/doc/blog/index
- https://www.cyberbotics.com/doc/discord/index
- https://www.cyberbotics.com/doc/automobile/index

You are very welcome to contribute to make this documentation better.
In order to proceed, follow these steps:
1. Fork this repository
2. Make your modifications
3. 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=develop
```

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
```

## To Run the doc locally, follow these steps:

1. Set the terminal to the 'docs' directory.

```sh
cd $WEBOTS_HOME/docs
```

2. Create or update the `index.html` page:

```sh
python local_exporter.py
```

3. Run a simple HTTP server:

```sh
python -m http.server 8000
```

4. Then in a browser, open:

- [http://localhost:8000/?url=&book=guide](http://localhost:8000/?url=&book=guide)
- [http://localhost:8000/?url=&book=reference](http://localhost:8000/?url=&book=reference)
- [http://localhost:8000/?url=&book=blog](http://localhost:8000/?url=&book=blog)
- [http://localhost:8000/?url=&book=automobile](http://localhost:8000/?url=&book=automobile)


## For running the unit tests, the following steps should be followed:

1. Install the pep8 module:

```sh
sudo apt-get install python-pip
pip install pep8
```

2. Run the tests:

```sh
cd $WEBOTS_HOME/docs
python -m unittest discover
```