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.

Sign up for GitHub

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

Jump to bottom

Make it possible to configure output directory of render_docs #299

Open
nsheff opened this issue Nov 23, 2024 · 2 comments · May be fixed by #300
Open

Make it possible to configure output directory of render_docs #299

nsheff opened this issue Nov 23, 2024 · 2 comments · May be fixed by #300

Comments

@nsheff
Copy link

nsheff commented Nov 23, 2024

I want to render the docs into a separate folder, somewhere else. The documentation seems to indicate I can point it to a different intput source, through path, but not to a different output location:

     render_docs(path = ".", verbose = FALSE, parallel = FALSE, freeze = FALSE)
     
Arguments:

    path: Path to the package root directory.

I want something like:

render_docs(output_path="../../docs/thisRPackage")

because I have a single mkdocs site, which I want to hold the rendered documentation from multiple packages, which I would put as subfolders in a /docs parent folder.
@etiennebacher
Copy link
Owner

etiennebacher commented Nov 23, 2024 •
edited
Loading

Looks reasonable to me.

@vincentarelbundock thoughts about this API change? (I could take care of it)

@vincentarelbundock
Copy link
Collaborator

I think that would be nice, but I half remember we had something like this in a prior version, and deprecated it because tracking paths was a nightmare.

Unfortunately, I don't have time for this, but if you want to take a shot, I'm sure some people would find it useful.

IIUC, it's just about adding a new argument, so in principle it should not break existing workflows.

@etiennebacher etiennebacher linked a pull request Nov 23, 2024 that will close this issue
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Add output_path argument to render_docs() etiennebacher/altdoc
3 participants
@vincentarelbundock @nsheff @etiennebacher