Edit the documentation¶
This documentation is created with Sphinx. Sphinx uses the reStructuredText (RST) markup format and adds some features like cross-referencing.
In this tutorial we will teach you how to edit the documentation locally on your PC. For that we will use Visual Studio Code with the reStructuredText extension, that will give you a (somewhat) live preview.
For small changes you can click the Edit on GitHub button in the top right corner. GitHub however will only render the files as plain RST and miss all features that Sphinx adds.
Checkout the eCAL git repository:
git clone https://github.com/continental/ecal.git
Download and install Visual Studio Code on your PC (it is available for Windows, Linux and macOS).
Download and install Python 3.5 or newer (Python 3.8 recommended) and make sure it is added to the
Choose “Add Python to PATH”
sudo apt install python3 python3-pip python3-wheel
Navigate to the eCAL directory and install the python requirements with pip:
Python virtual environments are not supported
pip install wheel pip install -r requirements.txt pip install sphinx-autobuild
sudo pip3 install -r requirements.txt sudo pip3 install sphinx-autobuild
Install the VS Code Extensions:
reStructuredTextby LeXStudio Inc.
doc/rst/directory in VS Code. Open an .rst file of your choice and click the preview button in the upper right corner. If VS Code asks you how to create the preview, select
After a short time you should have a beautiful preview of the documentation. The preview will be updated every time you save the .rst file.