Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

CRAN requires HTML5 for documentation #240

Closed
florianhartig opened this issue Sep 8, 2022 · 1 comment
Closed

CRAN requires HTML5 for documentation #240

florianhartig opened this issue Sep 8, 2022 · 1 comment

Comments

@florianhartig
Copy link
Owner

florianhartig commented Sep 8, 2022

From CRAN

Dear maintainer,

Please see the problems shown on
https://cran.r-project.org/web/checks/check_results_BayesianTools.html.

In particular, please see the "Found the following HTML validation
problems" NOTEs in the "HTML version of manual" check for at least some
of the r-devel checks results.

R 4.2.0 switched to use HTML5 for documentation pages. Now validation
using HTML Tidy finds problems in the HTML generated from your Rd
files.

To fix, in most cases it suffices to re-generate the Rd files using the
current CRAN version of roxygen2. To check whether this already fixes
things, or whether additional changes you made fixed the problems (e.g.,
if the problem is from yourself directly generating HTML output), you
can grab HTML Tidy version 5.8.0 binaries from
https://binaries.html-tidy.org/ and, with FOO.Rd an Rd file for which
problems were found, run

R CMD Rdconv -t html /path/to/FOO.Rd -o FOO.html
tidy -qe --drop-empty-elements no FOO.html

(Alternatively, you can use R CMD check --as-cran using a current
version of R-devel.)

Note that

was removed from HTML5: you can use style attributes
(e.g., style="text-align: center;") instead.

Can you please fix as necessary?

Please correct before 2022-09-14 to safely retain your package on CRAN.

Best,
-k

@florianhartig florianhartig added this to the BT 0.1.8 Release milestone Sep 8, 2022
@florianhartig
Copy link
Owner Author

This seems to be solved with recent updates

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

No branches or pull requests

1 participant