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

Integrate the generation of Internal and Online documentation with roxygen2/pkgdown #168

Closed
christophergandrud opened this issue Jan 23, 2017 · 1 comment
Assignees
Labels
Milestone

Comments

@christophergandrud
Copy link
Contributor

I think we should convert the Zelig online documentation generation to pkgdown. This has a number of advantages:

  • Easily enable close integration with the internal documentation, which is currently different from the online documentation in ways that are potentially confusing to users

  • Closer test integration as the online docs could be tested every time Zelig goes through a build check. This would enable more accurate documentation (e.g. docs that don't include errors) and provide another "test surface" for finding errors.

  • Simplify package development toolchain.

@christophergandrud
Copy link
Contributor Author

Ongoing in: https://github.com/IQSS/Zelig/tree/pkgdown

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