[RTEMS Project] #4648: User manual documentation updates

RTEMS trac trac at rtems.org
Mon May 9 11:45:45 UTC 2022


#4648: User manual documentation updates
-----------------------------+---------------------
 Reporter:  Chris Johns      |       Owner:  (none)
     Type:  defect           |      Status:  new
 Priority:  normal           |   Milestone:  6.1
Component:  doc              |     Version:  6
 Severity:  blocker          |  Resolution:
 Keywords:  user manual doc  |  Blocked By:
 Blocking:                   |
-----------------------------+---------------------

Comment (by Chris Johns):

 The use of `.. include::` in the nested `index.rst` files breaks the
 parsing of Sphinx. I have discovered the read in source that passes
 through the `source-read` hook is not in the some of the generated HTML
 pages. I cannot tell if this is a bug in Sphinx, the theme or something
 else but using the `.. toctree::` works.

 We need to change the use includes and update the `README.txt`.

--
Ticket URL: <http://devel.rtems.org/ticket/4648#comment:5>
RTEMS Project <http://www.rtems.org/>
RTEMS Project


More information about the bugs mailing list