etiennebacher / altdoc

Alternative to pkgdown to document R packages
https://altdoc.etiennebacher.com
Other
69 stars 9 forks source link

BUG: cannot render docs #293

Open paulduf opened 2 months ago

paulduf commented 2 months ago

Hello, I am having an issue trying to render the docs following the "Get started" example

r$> render_docs()

── Basic files ──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────
✔ README imported.

── Man pages ────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────
ℹ Found 3 man pages to convert.
Error in cat(out[[2]]) : erence 1/3: infer_source
  argument 1 (type 'list') cannot be handled by 'cat'
✖ Converting function reference 1/3: infer_source [150ms]

The .Rd file is very basic

% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/format.R
\name{infer_source}
\alias{infer_source}
\title{Using concentration as the unique identifier column}
\usage{
infer_source(df)
}
\description{
Using concentration as the unique identifier column
}

Running rlang::last_trace() I get Error: Can't show last error because no error was recorded yet because I guess I cannot catch the error coming from a subprocess, so I'm a bit disappointed how to further debug this.

r$> packageVersion("devtools")
[1] ‘2.4.5’

r$> packageVersion("roxygen2")
[1] ‘7.3.2’

r$> packageVersion("altdoc")
[1] ‘0.4.0’

A few details about my setup, I'm using the R devcontainer from VSCode, linux-desktop, and following R / packages versions:

r$> version
               _                           
platform       x86_64-pc-linux-gnu         
arch           x86_64                      
os             linux-gnu                   
system         x86_64, linux-gnu           
status                                     
major          4                           
minor          4.1                         
year           2024                        
month          06                          
day            14                          
svn rev        86737                       
language       R                           
version.string R version 4.4.1 (2024-06-14)
nickname       Race for Your Life   
etiennebacher commented 2 months ago

Hi, would you be able to share a repo where this happens? Also, do you use quarto or another tool?

etiennebacher commented 2 months ago

Hi @paulduf, do you still have this bug? If so, can you let us know what tool you're using and if you have a public repository we could use?

paulduf commented 1 week ago

Hello, I kindof lost track of this issue, because I switched to pkgdown, so I'm not sure I can reproduce easily. The repo was private anyway, but it was really barebone at that point in time.