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

Investigate supporting roxygen2 documentation via markdown #39

Closed
gfinak opened this issue Jul 31, 2018 · 2 comments
Closed

Investigate supporting roxygen2 documentation via markdown #39

gfinak opened this issue Jul 31, 2018 · 2 comments

Comments

@gfinak
Copy link
Member

gfinak commented Jul 31, 2018

Need to see what's involved in doing this and how this could be incorporated first.

@gfinak
Copy link
Member Author

gfinak commented Aug 1, 2018

It seems the maxygen package can do this https://github.com/gaborcsardi/maxygen
but it registers callbacks for roxygen that cannot be unregistered without a restart of the R session, so
mixing regular R-based roxygen and maxygen may not be possible at this time.
ropensci/software-review#230

@gfinak
Copy link
Member Author

gfinak commented Aug 1, 2018

As noted by @wlandau, adding Roxygen: list(markdown = TRUE) to the DESCRIPTION will enable support for markdown based roxygen.

@gfinak gfinak closed this as completed Aug 2, 2018
@gfinak gfinak reopened this Aug 2, 2018
@gfinak gfinak closed this as completed in 2915cc9 Aug 2, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant