Skip to content

Fix the pkgdown build - #103

Merged
mstackhouse merged 1 commit into
mainfrom
fix-pkgdown-index
Sep 4, 2026
Merged

mstackhouse merged 1 commit into
mainfrom
fix-pkgdown-index

Conversation

@mstackhouse

Copy link
Copy Markdown
Member

The pkgdown workflow failed on the 0.4.0 merge (run):

Error in `build_reference_index()`:
! In _pkgdown.yml, 1 topic missing from index: "datasetjson_example".

datasetjson_example() was exported by #90 but never added to the reference index. pkgdown treats a missing topic as an error, not a warning, so the whole site build stops there. Checked the other 22 exports at the same time — it was the only one missing.

Also cleared the two warnings the same build reported:

  • date_time_datetime and precision declared \VignetteIndexEntry values that did not match their YAML titles, so the vignette index listed them by filename instead of "Dates, Times, and Datetimes" and "Numeric Precision"
  • the codecov and licence badges in README.Rmd were raw <img> tags with no alt text

pkgdown::check_pkgdown() reports no problems, a full local build_site() completes with nothing under "Checking for problems", and R CMD check --as-cran is still 0/0/0.

None of this affects the package source, so the 0.4.0 tarball already with CRAN is unaffected.

The reference index did not list datasetjson_example(), which pkgdown
treats as an error rather than a warning, so the site build failed on
the 0.4.0 merge. It is now under Helper Functions alongside the other
two.

Also cleared the two warnings the same build reported:

- date_time_datetime and precision declared \VignetteIndexEntry values
  that did not match their titles, so the vignette index listed them by
  filename rather than as "Dates, Times, and Datetimes" and "Numeric
  Precision"
- the codecov and licence badges in README.Rmd were raw <img> tags with
  no alt text
@mstackhouse
mstackhouse merged commit b75f69c into main Sep 4, 2026
9 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant