![[RTEMS Logo]](/images/logo.png){kind=logo}
Opened on 02/01/17 at 10:24:33
Last modified on 10/10/17 at 06:06:29
#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 02/01/17 at 14:26:46 by Joel Sherrill
comment:2 Changed on 02/01/17 at 14:28:14 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 02/01/17 at 23:48:26 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 02/15/17 at 14:20:42 by Sebastian Huber
| Milestone: | 4.12 → Indefinite |
|---|---|
| Owner: | set to Needs Funding |
| Status: | new → assigned |
comment:5 Changed on 10/10/17 at 06:06:29 by Sebastian Huber
| Component: | Documentation → doc |
|---|
Note: See
TracTickets for help on using
tickets.
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.