Opened on 08/03/22 at 03:42:50

Last modified on 11/29/22 at 22:52:11

#4695 assigned defect

Automatic version numbers in the documentation

Reported by: Chris Johns Owned by: Chris Johns
Priority: high Milestone: 6.1
Component: doc Version: 6
Severity: blocker Keywords:
Cc: Blocked By:
Blocking:

Description

There is no easy means to add the current version number to the documentation using the Sphinx. The supported directives and variables are fine in the documentation however they are no applied in the code blocks.

Provide a means to support a version number that can be used in the documentation and code blocks.

We should also review the documentation code blocks and find ways to include content that does not vary from version to version.

Change History (7)

comment:1 Changed on 08/04/22 at 21:50:09 by Chris Johns <chrisj@…>

In c935a2c/rtems-docs:

building: Add support for an RTEMS version number

  • Support using a version number for RTEMS documentation

Updates #4695

comment:2 Changed on 08/04/22 at 21:50:11 by Chris Johns <chrisj@…>

In e551cc7/rtems-docs:

versions: Update aarch64

Updates #4695

comment:3 Changed on 08/04/22 at 21:50:12 by Chris Johns <chrisj@…>

In f028448/rtems-docs:

versions: Update arm

Updates #4695

comment:4 Changed on 08/04/22 at 21:50:14 by Chris Johns <chrisj@…>

In 3859073/rtems-docs:

versions: Update microblaze, powerpc, riscv and x86_64

Updates #4695

comment:5 Changed on 08/04/22 at 21:50:15 by Chris Johns <chrisj@…>

In 1d6dcf8/rtems-docs:

versions: Update user manual

Updates #4695

comment:6 Changed on 11/29/22 at 22:50:56 by Chris Johns

Severity: normal → blocker

We need to complete this to make a 6.1 release.

comment:7 Changed on 11/29/22 at 22:52:11 by Chris Johns

Priority: normal → high
Note: See TracTickets for help on using tickets.