Getting Started: Build Documentation
This task introduces you to the processes involved in creating the RTEMS Documentation Manuals. Completion of this task is a pre-requisite for other tasks that involve the Documentation Manuals.
Additional task instructions are available on our wiki.
The RTEMS Documentation is built using the Sphinx toolset which supports the reStructuredText mark up format. The source for the RTEMS Documentation is maintained in git just like the RTEMS Source Code.
Your task is to clone the rtems-docs.git repository, install the tools needed to build the manuals, then edit a manual and rebuild it, and submit a patch of your edit along with the generated PDF manual. You are also asked to provide feedback on the process and to help improve our instructions for building the documentation manuals.
If you have any questions please feel free to ask here, on the #rtems channel of Freenode, or by email to gci@rtems.org or devel@rtems.org.
Task tags
Students who completed this task
Task type
- chrome_reader_mode Documentation / Training