augur icon indicating copy to clipboard operation
augur copied to clipboard

Fix the documentation build

Open JohnStrunk opened this issue 7 months ago • 2 comments

Description

While the current build of the documentation succeeds well enough to generate the RTD documentation, it also produces over a page worth of warnings, including calling out several pages that aren't linked into the doc tree at all (due to typos) as well as several missing images.

To do

  • Fix the warnings/errors
  • Add a GH actions job that builds the docs, ensuring that it remains free from errors/warnings in the future.

JohnStrunk avatar May 22 '25 15:05 JohnStrunk

@JohnStrunk : This would be removing the errors generated during local builds? Just confirming you are not seeing failed builds on readthedocs.io ...

sgoggins avatar Jun 08 '25 22:06 sgoggins

Yes, it's for local builds. They happen on RTD as well, but they aren't fatal, so the docs do still get built.

JohnStrunk avatar Jun 08 '25 23:06 JohnStrunk

The mentioned PR seems to say it fixes this one but GH didn't mark it for auto closing. Closing as completed.

MoralCode avatar Jul 17 '25 15:07 MoralCode