Opened on 11/12/17 at 23:04:38

Closed on 11/13/17 at 00:54:00

Last modified on 11/13/17 at 02:27:40

#3232 closed defect (fixed)

Use of `.. include::` in the User Manual should be changed.

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

Description

This tricket for Sphinx highlights an issue when using .. include::, we should be using .. toctree:::

​https://github.com/sphinx-doc/sphinx/issues/3432

Change History (2)

comment:1 Changed on 11/13/17 at 00:54:00 by Chris Johns <chrisj@…>

Resolution: → fixed
Status: assigned → closed

In ac0eaff/rtems-docs:

Use '.. toctree::' and not '.. include::' in the User Manual.

  • Change all suitable '.. include::' to TOC tree.
  • Remove unused and not needed sections.
  • Fix the conf.py to not exclude some files.

Close #3232.

comment:2 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.

Note: See TracTickets for help on using tickets.