#2892 assigned defect

Use of C domain in shpinx documentation?

Reported by: Sebastian Huber Owned by: Needs Funding
Priority: normal Milestone: Indefinite
Component: doc Version: 5
Severity: normal Keywords:
Cc: Blocked By:
Blocking:

Description

The sphinx documentation framework provides so called C/C++ domains for C/C++ API documentation:

http://www.sphinx-doc.org/en/stable/domains.html#c-roles

This feature is not used in the RTEMS documentation. Should it be used? Do we need a custom domain for the API documentation?

The PDF output of the C/C++ domain constructs is quite bad.

Change History (5)

comment:1 Changed on Feb 1, 2017 at 2:26:46 PM by Joel Sherrill

I recall Chris and I tried to get this working but failed. Perhaps more is correct now and it will work. Give it a try. Using Sphinx is a learning experience for us all.

comment:2 Changed on Feb 1, 2017 at 2:28:14 PM by Sebastian Huber

I used the C domain for the self-contained objects chapter. The HTML output looks ok, but the PDF output is not really good. I will ask on the sphinx group.

comment:3 Changed on Feb 1, 2017 at 11:48:26 PM by Chris Johns

I also found this and backed away from this path as I did have the time to invest becoming a sphinx master.

comment:4 Changed on Feb 15, 2017 at 2:20:42 PM by Sebastian Huber

Milestone: 4.12Indefinite
Owner: set to Needs Funding
Status: newassigned

comment:5 Changed on Oct 10, 2017 at 6:06:29 AM by Sebastian Huber

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