[llvm-dev] 404s within LLVM documentation
Alex Brachet-Mialot via llvm-dev
llvm-dev at lists.llvm.org
Wed Aug 28 19:11:09 PDT 2019
I don’t know the best way to do this, but big +1 that it would be great if
there could somehow be tests for broken documentation.
I don’t know this for sure, but I believe there aren’t even currently bots
testing if the doxygen and sphinx docs were successfully built.
On Wed, Aug 28, 2019 at 9:52 PM Patrick Nappa via llvm-dev <
llvm-dev at lists.llvm.org> wrote:
> Hi all,
> I'm currently in the process of updating the Kaleidoscope tutorials (first
> and foremost, the ORC/BuildingAJIT ones), and I've noticed a fair few 404s
> which are lingering within the current visible documentation. Some of these
> don't seem to have linked to existing pages for a while.
> I was wondering if there was a way to set up a check in the buildbot to
> ensure that documentation doesn't break between builds? I'm happy to fix
> the current dead links I've found (see below) but thought it might be wise
> to set up a more automated approach in the future. Does anyone have any
> tips on how I'd go about doing this/if this should be set up at all?
> I ran a web crawler to find each of the dead links (this may not be
> exhaustive), and they are as follows:
> Some of these are trivial mistakes (i.e.
> https://llvm.org/docs/tutorial/LangRef.html#instruction-reference ->
> https://llvm.org/docs/LangRef.html#instruction-reference), and some
> require a bit more inspection.
> LLVM Developers mailing list
> llvm-dev at lists.llvm.org
-------------- next part --------------
An HTML attachment was scrubbed...
More information about the llvm-dev