tutorial formatting and style rules - #179
Conversation
| @@ -34,4 +34,47 @@ For deploying documentation changes to the web, [Section 3 of rosdoc_lite wiki]( | |||
|
|
|||
| ## Contributing | |||
There was a problem hiding this comment.
Add in intro sentence for the contributing section encouraging everyone to make the tutorials better :)
| ├── <tutorial_name>_tutorial.rst | ||
| ├── CMakeLists.txt # If the tutorial contains executable code | ||
| ├── package.xml | ||
| ├── setup.py |
There was a problem hiding this comment.
# If the tutorial contains python
There was a problem hiding this comment.
I feel this is already covered by 'Tutorials should use the following directory structure omitting unnecessary files and subdirectories'
There was a problem hiding this comment.
Then you shouldn't have '# If the tutorial contains executable code'
There was a problem hiding this comment.
fair. I'll standardize
| │ ├── __init__.py | ||
| │ ├── <tutorial_name>_tutorial.py # Main Python executable | ||
| │ └── <python_library>.py # Custom Python libraries | ||
| └── test/ |
There was a problem hiding this comment.
# Ideally tutorials have their own integration tests
|
Please send a reminder again after June, 25th. Currently, I'm too busy with preparing a demo for Automatica fair. |
4 participants
Significant effort was put in to make the tutorials more consistent. This is my attempt to create structure so that future changes adhere to these same style, formatting and structure.
Once we come to an agreement here I can start fixing up the existing tutorials so that they better adhere to these guidelines.
@davetcoleman
@rhaschke
@v4hn