RTEMS Project

RTEMS Software Engineering Handbook: Sphinx Manual First Draft

Before attempting this task, you should first complete the "Getting Started: Build Documentation" tasks.

This task involves reformatting the current draft of the Software Engineering Handbook into ReST according to the guidelines for RTEMS manuals and submitting it as a new manual. The outline of the new manual is available on the wiki task description page. Using an existing manual in the rtems-docs.git as a template, convert the outline into a new manual. Verify that your new manual builds correctly.

You will submit a patch that you make against https://git.rtems.org/rtems-docs.git that adds the new manual with the initial table of contents. You will also submit the PDF generated file of the new manual.

Task tags

  • rst
  • sphinx

Students who completed this task


Task type

  • code Code
  • chrome_reader_mode Documentation / Training