Opened on 01/27/23 at 13:59:43
Last modified on 02/15/23 at 20:33:57
#4826 assigned defect
Software Engineering Guide has broken Reference
Reported by: | Joel Sherrill | Owned by: | Chris Johns |
---|---|---|---|
Priority: | normal | Milestone: | 6.1 |
Component: | doc | Version: | |
Severity: | normal | Keywords: | |
Cc: | Blocked By: | ||
Blocking: |
Description (last modified by Joel Sherrill)
Section 3, RTEMS Stakeholders, has a single paragraph which renders like this in the html at https://docs.rtems.org/branches/master/eng/stakeholders.html:
Please have a look at the Support and Contributing chapter of the ERROR: :r:url:`user`.
A bit of investigation shows that it is trying to link to https://docs.rtems.org/branches/master/user/support/index.html. That section appears to be there correctly.
Looking for documentation for the ":r:url:" syntax, I could not find any on the net. I see 48 uses of ":r:". I suspect but did not check that they all might be broken. What is ":r:" and what makes it work?
Change History (5)
comment:1 Changed on 01/27/23 at 14:08:24 by Joel Sherrill
Description: | modified (diff) |
---|---|
Owner: | set to Chris Johns |
Status: | new → assigned |
comment:2 Changed on 02/14/23 at 22:17:00 by Chris Johns
comment:3 Changed on 02/14/23 at 22:17:19 by Chris Johns
Owner: | changed from Chris Johns to Joel Sherrill |
---|
comment:4 Changed on 02/15/23 at 07:03:49 by Sebastian Huber
This :r:
stuff is implemented in common/rtemsdomain.py
. It seems to be a Sphinx customization. It used to work at some point in time.
comment:5 Changed on 02/15/23 at 20:33:57 by Chris Johns
Owner: | changed from Joel Sherrill to Chris Johns |
---|
The domains could have been broken by me when I updated that code to handle the version number change.
I will take a look. My comment about URL links is related to references between different documents only. References in a document is supported.
Sorry for the confusion.
You cannot have links like this to rolling released versions of the documentation in the documentation and it needs to be removed.