#3229 closed defect (fixed)

Add index to all documents.

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


Indexes currently do not work. Fix this adding them to all documents.

Add index entries where possible.

Change History (9)

comment:1 Changed on 11/11/17 at 23:08:46 by Chris Johns

Status: assignedaccepted

comment:2 Changed on 11/11/17 at 23:43:38 by Chris Johns <chrisj@…>

In 42d50d7/rtems-docs:

Add indexes to all documents.

Update #3229.

comment:3 Changed on 11/12/17 at 02:57:42 by Chris Johns

I have noticed all the c-user guide has .. index:: labels after headings and they should be before the headings. They need to be moved to before to make clicking on an index work better. This needs to happen on all documents.

comment:4 Changed on 11/12/17 at 03:35:39 by Chris Johns <chrisj@…>

In 6c56401/rtems-docs:

c-user: Fix index locations.

Update #3229.

comment:5 Changed on 11/13/17 at 02:27:40 by Chris Johns <chrisj@…>

In 3384994/rtems-docs:

Clean up sphinx warnings.

  • Fix minor formatting issues.
  • Fix reference the gloassary TLS using ':term:'.
  • Make sure nothing is between an anchor and the heading where ':ref:' references the anchor. This meant moving all the recently added '.. index::' entries.

Update #3232.
Update #3229.

comment:6 Changed on 11/14/17 at 22:04:30 by Chris Johns

The documentation README needs updating to explain the formatting I fixed in the last change in this ticket.

comment:8 Changed on 02/05/18 at 09:48:28 by Sebastian Huber <sebastian.huber@…>

In 13debfb/rtems-docs:

c-user: Fix index directives

Update #3229.

comment:9 Changed on 10/14/18 at 00:36:36 by Joel Sherrill

Resolution: fixed
Status: acceptedclosed

Fixed on review doc master.

Note: See TracTickets for help on using tickets.