Opened 3 years ago

Closed 3 years ago

Last modified 3 years ago

#19516 closed Cleanup/optimization (fixed)

Fix broken sphinx references in docs

Reported by: timo Owned by: timo
Component: Documentation Version: master
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 Changed 3 years ago by aaugustin

  • Needs documentation unset
  • Needs tests unset
  • Patch needs improvement unset
  • Triage Stage changed from Unreviewed to Accepted

comment:2 Changed 3 years ago by Tim Graham <timograham@…>

In f56f6cfa58345b964ceb2614e4366639381c8f6f:

Fixed links to DATABASE ENGINE setting. refs #19516

comment:3 Changed 3 years ago by Tim Graham <timograham@…>

In 5489fc47df76c3f25a959510b885fa9a28b495b4:

[1.5.X] Fixed links to DATABASE ENGINE setting. refs #19516

Backport of f56f6cfa58 from master

comment:4 Changed 3 years ago by Tim Graham <timograham@…>

In 9c5a6adf3341c59efee4ca6d0037f8069185e0e3:

Fixed more broken links. refs #19516

comment:5 Changed 3 years ago by Tim Graham <timograham@…>

In 1c1df12388e394b7f1dc3949d23b99fa80cf6f6a:

[1.5.X] Fixed more broken links. refs #19516

Backport of 9c5a6adf33 from master

comment:6 Changed 3 years ago by Tim Graham <timograham@…>

In b3a8c9dab87be6bc4b8096d292abe0b35c700bdd:

Fixed broken links, round 3. refs #19516

comment:7 Changed 3 years ago by Tim Graham <timograham@…>

In fbc06eef1af1d7ecf91fae5a94a1994f356ffd22:

[1.5.X] Fixed broken links, round 3. refs #19516

Backport of b3a8c9dab8 from master

comment:8 Changed 3 years ago by Tim Graham <timograham@…>

In 067505ad19f088e8db1d8c788ceea388c7241bcd:

Fixed broken links, round 4. refs #19516

comment:9 Changed 3 years ago by Tim Graham <timograham@…>

In 9e5ada79bf2d25fa862babe74517a6c7b5b89968:

[1.5.x] Fixed broken links, round 4. refs #19516

Backport of 067505ad19 from master

comment:10 Changed 3 years ago by Tim Graham <timograham@…>

In a04df803a590c5bffd9437d9199bc0107ba0e966:

Removed links to deprecated IGNORABLE_404_STARTS/ENDS settings.

refs #19516 and 641acf76e7

comment:11 Changed 3 years ago by timo

  • 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 Changed 3 years ago by aaugustin

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 Changed 3 years ago by timo

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 Changed 3 years ago by Tim Graham <timograham@…>

  • Resolution set to fixed
  • Status changed from new to closed

In 9b5f64cc6ed5f1e904093fe4e6ff0f681b8e545f:

Fixed #19516 - Fixed remaining broken links.

Added -n to sphinx builds to catch issues going forward.

comment:15 Changed 3 years ago by Tim Graham <timograham@…>

In be1e006c581cc45ed48ae0b423e7a0a996d2199b:

[1.5.x] Fixed #19516 - Fixed remaining broken links.

Added -n to sphinx builds to catch issues going forward.

Backport of 9b5f64cc6e from master.

Note: See TracTickets for help on using tickets.
Back to Top