docs-community icon indicating copy to clipboard operation
docs-community copied to clipboard

Add automation to prevent breaking URLs

Open encukou opened this issue 3 years ago • 2 comments
trafficstars

(This was discussed at one of the meetings, filing an issue so it isn't forgotten.)

Any kind of reorganization can break existing URLs. Ideally any breakage is intentional rather than accidental. Even more ideally, we add some redirect mechanism.

Brian Skinn's sphobjinv library might be useful for inspecting Sphinx inventories.

encukou avatar Aug 02 '22 15:08 encukou

Sphinx-Rediraffe, which we now use on the devguide, can also automatically check this at least at the page level.

CAM-Gerlach avatar Aug 03 '22 04:08 CAM-Gerlach

Aha, I didn't realize what you were trying to do from the comment in the meeting notes.

sphinx-rediraffe absolutely looks like what you want, not sphobjinv.

bskinn avatar Aug 04 '22 13:08 bskinn