#3503 closed defect (fixed)

PDF Documentation is missing an index

Reported by: Chris Johns Owned by: Chris Johns
Priority: high Milestone: 5.1
Component: doc Version: 5
Severity: critical Keywords:
Cc: Blocked By:
Blocking:

Description

The PDF generated documents have an empty index.

Change History (3)

comment:1 Changed on Aug 21, 2018 at 2:14:12 AM 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.

comment:2 Changed on Aug 21, 2018 at 3:48:28 AM by Chris Johns <chrisj@…>

Resolution: fixed
Status: assignedclosed

In 5ce8e43/rtems-docs:

build: Fix indexing so it works on HTML and PDF.

  • Remove all genindex.rst files, these are generated and should not exist in our source.
  • Fix the HTML templates so the local specialisation works.
  • Add a index link to the sidebar for HTML.

Note, there is no TOC entry for the index in the PDF output and I
cannot figure out how to add one.

Closes #3503

comment:3 Changed on Aug 21, 2018 at 5:00:24 AM by Sebastian Huber

Component: admindoc
Note: See TracTickets for help on using tickets.