edgararuiz / ecodown Goto Github PK

Mangled output for %<-active% function (rstudio/tensorflow.rstudio.com#16)

Moving this single issue here

https://github.com/rstudio/spark.rstudio.com/blob/main/.github/workflows/ecodown.yaml

https://tensorflow.rstudio.com/reference/keras/summary.keras.engine.training.model#usage

• Missing function [[ from keras
• Mangled output for %<-active% function (rstudio/tensorflow.rstudio.com#16)
• Sections look concatenated: https://tensorflow.rstudio.com/reference/keras/#text-preprocessing

https://github.com/t-kalinowski/tensorflow.rstudio.com/blob/main/_utils/build-reference.R

E.g., tensorflow::install_tensorflow() here not a link.
https://tensorflow.rstudio.com/reference/keras/install_keras.html#see-also

Add a function that verifies if all of existing publishable content (qmd's, rmd's and md's) that are in the project's folder are also listed in the _quarto.yml file, and provide a warning if some are missing from either.

https://tensorflow.rstudio.com/reference/keras/metric

Docs for tensorflow::install_tensorflow() contain two sections with non-runnable code chunks. This is how they currently appear on the website:

This is how they appear in R's generated html (viewed from the ide, and as served up my help.start()):

Temporary fix applied for this reference page: rstudio/tensorflow.rstudio.com@5f479cd

But this is a pretty common doc pattern for packages where code can't easily be run on CRAN (e.g., keras), so likely there are other pages w/ this issue.

Consider either switching to, or adding the ability for the reference files to be output to Qmd instead of Md

Currently, the reference pages created by ecodown result in incorrect links on the rendered quarto page.

If the _quarto.yml has:

website:
  repo-actions: [edit]

Then the "Edit this page" link on each reference page points to the auto-generated markdown file, which is not where PR's should go. The link should ideally point to the roxygen block in the appropriate package R script.