#15133 closed (fixed)
:ref: directive in docs where :doc: directive should be used
Reported by: | Owned by: | nobody | |
---|---|---|---|
Component: | Documentation | Version: | dev |
Severity: | Keywords: | ||
Cc: | vim@… | Triage Stage: | Accepted |
Has patch: | no | Needs documentation: | no |
Needs tests: | no | Patch needs improvement: | no |
Easy pickings: | no | UI/UX: | no |
Description
Using sphinx 1.0.7 I get the following warnings when building the docs:
/home/altaurog/djangodoc/trunk/docs/ref/signals.txt:15: WARNING: undefined label: topics-auth (if the link has no caption the label must precede a section header) /home/altaurog/djangodoc/trunk/docs/releases/1.3-beta-1.txt:61: WARNING: undefined label: topics-auth (if the link has no caption the label must precede a section header) /home/altaurog/djangodoc/trunk/docs/topics/auth.txt:660: WARNING: undefined label: topic-signals (if the link has no caption the label must precede a section header)
Changing the offending :ref: directives to :doc: directives seems to resolve this issue. i.e.
The :doc:`authentication framework </topics/auth>` sends :ref:`signals when
Note that the reference in topics/auth.txt should be </topics/signals>
not </topic/signals>
Change History (4)
comment:1 by , 14 years ago
Cc: | added |
---|---|
Summary: | :ref: directive in docs where :doc: directve should be used → :ref: directive in docs where :doc: directive should be used |
follow-up: 4 comment:2 by , 14 years ago
Triage Stage: | Unreviewed → Accepted |
---|
comment:3 by , 14 years ago
Resolution: | → fixed |
---|---|
Status: | new → closed |
comment:4 by , 14 years ago
Replying to russellm:
Confirmed; this appears to be a recent change, because Sphinx 1.0.7 reports the error, but Sphinx 1.0.5 didn't.
I suspected as much; I started seeing the error on Jan 16, the day after Sphinx 1.0.7 was released, but the django svn log didn't show any recent changes to the offending lines. I guess this is one hazard--or benefit--of a build script which installs the latest sphinx afresh each time it runs.
Confirmed; this appears to be a recent change, because Sphinx 1.0.7 reports the error, but Sphinx 1.0.5 didn't.