[RTEMS Project] #3503: PDF Documentation is missing an index

RTEMS trac trac at rtems.org
Tue Aug 21 02:14:12 UTC 2018


#3503: PDF Documentation is missing an index
-------------------------+--------------------------
 Reporter:  Chris Johns  |       Owner:  Chris Johns
     Type:  defect       |      Status:  assigned
 Priority:  high         |   Milestone:  5.1
Component:  admin        |     Version:  5
 Severity:  critical     |  Resolution:
 Keywords:               |  Blocked By:
 Blocking:               |
-------------------------+--------------------------

Comment (by Chris Johns):

 We cannot have a `genindex.rst` file, the documentation reserves this for
 a generated file. Removing the `genindex` entry from the TOC of a document
 results in the PDF having an index. Removing the `genindex` entry from the
 TOC removes the index from the HTML generated output.

 The solution is to specialize the HTML template however the template
 processing in `common` and `common/waf.py` looks broken. The path in
 `common/conf.py` is a build path that is not present and the common
 templates are copied into each docs HTML build tree and the path in the
 file is relative to the top directory.

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


More information about the bugs mailing list