carla-simulator / scenario_runner

Traffic scenario definition and execution engine
https://carla-scenariorunner.readthedocs.io/en/latest/
MIT License
521 stars 358 forks source link

Create user/developer documentation #442

Open fabianoboril opened 4 years ago

fabianoboril commented 4 years ago

We should create proper documentation with ReadTheDocs for ScenarioRunner.

User documentation should cover:

Developer documentation should additionally cover:

The API documentation can be done with mkdocstrings (https://github.com/pawamoy/mkdocstrings) Maybe we need to use Python mocking to work around missing imports on Travis (e.g. numpy, carla, etc.)

werewolfdev commented 3 years ago

@fabianoboril Thanks a lot for this .Looking forward to this docu