#19516 closed Cleanup/optimization (fixed)
Fix broken sphinx references in docs
| Reported by: | Tim Graham | Owned by: | Tim Graham |
|---|---|---|---|
| Component: | Documentation | Version: | dev |
| Severity: | Normal | Keywords: | |
| Cc: | Triage Stage: | Accepted | |
| Has patch: | yes | Needs documentation: | no |
| Needs tests: | no | Patch needs improvement: | no |
| Easy pickings: | no | UI/UX: | no |
Description
I'd like to add -n (Run in nit-picky mode, warn about all missing references) to the sphinx make file. This involves some cleanup of legitimate failures as well as removing the annotations for example classes like AuthorDetail which I don't think are designed to be linked (nearly 900 warnings). Any objections to doing this?
Change History (15)
comment:1 by , 12 years ago
| Triage Stage: | Unreviewed → Accepted |
|---|
comment:2 by , 12 years ago
comment:11 by , 12 years ago
| Has patch: | set |
|---|
Remaining issues fixed in a pull request: https://github.com/django/django/pull/616
My concern is removing links to items for which we actually want to add documentation. Feedback appreciated!
comment:12 by , 12 years ago
If I understand correctly, for example, if one day we document django.core.serializers.SerializerDoesNotExist, we'll have to replace all instances of ``django.core.serializers.SerializerDoesNotExist`` by :exception:`django.core.serializers.SerializerDoesNotExist`. That doesn't sound so bad.
Of course it's annoying to remove semantic markup, but it didn't have any effect on the output anyway.
comment:13 by , 12 years ago
That's right, I thought it might be useful to take a look at what's being removed now and create tickets if necessary.
comment:14 by , 12 years ago
| Resolution: | → fixed |
|---|---|
| Status: | new → closed |
In f56f6cfa58345b964ceb2614e4366639381c8f6f: