How to find broken local links when building docs

17 views
Skip to first unread message

Albertas Gimbutas

unread,
Feb 16, 2021, 8:51:11 AM2/16/21
to sphinx-users
Hello,

  I wonder is there a way to test if there is broken local links in my documentation? Sometimes pages are moved/renamed and I would like to detect when a cross reference gets broken. I imagine that this check could be done during documentation building or as pytest test case.

Best regards,
Albertas Gimbutas

Komiya Takeshi

unread,
Feb 16, 2021, 9:51:33 AM2/16/21
to sphinx...@googlegroups.com
Hi,

How do you make cross-references? I think Sphinx will warn if you're
using `:doc:` or `:ref:` roles for such a purpose.

Thanks,
Takeshi KOMIYA

2021年2月16日(火) 22:51 Albertas Gimbutas <alber...@gmail.com>:
> --
> You received this message because you are subscribed to the Google Groups "sphinx-users" group.
> To unsubscribe from this group and stop receiving emails from it, send an email to sphinx-users...@googlegroups.com.
> To view this discussion on the web visit https://groups.google.com/d/msgid/sphinx-users/0270f40d-0e99-4b96-aca8-dd68312dd657n%40googlegroups.com.
Reply all
Reply to author
Forward
0 new messages