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

CRAN release #8

Open
nevrome opened this issue Jun 6, 2019 · 7 comments
Open

CRAN release #8

nevrome opened this issue Jun 6, 2019 · 7 comments

Comments

@nevrome
Copy link
Collaborator

nevrome commented Jun 6, 2019

@mlysy

Sorry for disappearing for 10+ weeks. I think we can release this new version 2.0.0 of rdoxygen to CRAN. I updated the NEWS.md and the cran-comments.md.

Before we do so: Do you want to become the main maintainer of this package? I realized that I did not work with Rcpp for a long time now and I also believe you understand this package better than I do. I would love to stay in touch but pass the main responsibility on to you.

@mlysy
Copy link
Owner

mlysy commented Jun 10, 2019

Hi @nevrome, nice to hear from you.

I agree that we should go ahead and release rdoxygen 2.0.0 on CRAN. I'm happy to take over maintenance of the package, thanks for offering.

I'll admit that, while I still think that C++ documentation in R packages is a critical element error-free, portable, and efficient C++ code, I'm a bit less excited about doxygen vignettes. The main reason is that doxygen HTML documentation is rather large, adding ~300Kb as an upfront cost (although the extra Kb per documentation line is very little).

All this to say that I've yet to include doxygen documentation in any of my recent CRAN releases (although the doxygen markup is still there :). I'm working on a satisfactory solution to this, but I think the quickest approach would be to provide a simple mechanism to include the doxydoc in an automatically-generated pkgdown website.

Either way, I'm very glad to stay in touch :)

@nevrome
Copy link
Collaborator Author

nevrome commented Jun 11, 2019

OK - excellent. pkgdown might be a great extension for the future!

For the procedure: We somehow have to change the maintainership on CRAN. I suggest we try to do this as follows:

  1. I transfer this repo on github to you.
  2. You edit the DESCRIPTION accordingly and maybe add a sentence about the change in the cran-comments, the NEWS and the README.
  3. You submit.
  4. If I get contacted after the submission I will confirm the change.

@nevrome
Copy link
Collaborator Author

nevrome commented Jun 11, 2019

Oh - You have to get rid of your fork. I can't transfer the repo on github if mlysy/rdoxygen already exists.

@mlysy
Copy link
Owner

mlysy commented Jun 11, 2019

Thanks for looking into this. mlysy/rdoxygen has been deleted.

@thk686
Copy link

thk686 commented Feb 24, 2020

I'll admit that, while I still think that C++ documentation in R packages is a critical element error-free, portable, and efficient C++ code, I'm a bit less excited about doxygen vignettes. The main reason is that doxygen HTML documentation is rather large, adding ~300Kb as an upfront cost (although the extra Kb per documentation line is very little).

Is it not easy to simple exclude the generated output using .Rbuildignore?

@mlysy
Copy link
Owner

mlysy commented Feb 26, 2020

Unfortunately not without excluding the vignette altogether. That is, when you obtain a package from CRAN the vignettes do not get built. They are pre-built and shipped inside inst/doc.

@thk686
Copy link

thk686 commented Feb 26, 2020 via email

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

No branches or pull requests

3 participants