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

Link config-derived parameters to input documentation #65

Closed
zsusswein opened this issue Oct 7, 2024 · 3 comments
Closed

Link config-derived parameters to input documentation #65

zsusswein opened this issue Oct 7, 2024 · 3 comments
Labels

Comments

@zsusswein
Copy link
Collaborator

I'm not totally sure whether to do this inline or in a markdown doc. If inline, I could extend it everywhere using Roxygen2 inheritance.

@zsusswein zsusswein changed the title Link config-derived parameters to input documentation in Link config-derived parameters to input documentation Oct 7, 2024
@zsusswein
Copy link
Collaborator Author

Saw something over the weekend in the bridgestan docs. We can document everything in the roxygen docs, render to Rd, and then use rd2markdown to render to plain markdown. I think we could then check this into version control and link in the readme.

@zsusswein
Copy link
Collaborator Author

zsusswein commented Oct 15, 2024

The rd2markdown folks have examples in their readme of auto-including rendered Rd docs in the Readme by using a readme.Rmd and calling the function. @seabbs I remember you discouraging the Rmd approach as potentially adding a bunch of size bloat to the repo? Was that specifically to figures/model fitting or something you recommended avoiding in general?

Our readme is already getting pretty long, so I might go with linking out either way.

@zsusswein
Copy link
Collaborator Author

Closed by #99

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

1 participant