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

documenting multiple R packages in one rtd site #14

Open
erikriverson opened this issue Feb 27, 2023 · 1 comment
Open

documenting multiple R packages in one rtd site #14

erikriverson opened this issue Feb 27, 2023 · 1 comment

Comments

@erikriverson
Copy link

Hello! We are evaluating using this project, our use case is to host documentation for multiple R projects in a single RTD site. The homepage states

This package may easily be used to document several packages

I am wondering if there are any examples of this?

Thank you!

@mpadge
Copy link
Member

mpadge commented Mar 6, 2023

Yes indeed @erikriverson, this whole package was initially developed for this multiiple-package site, via source code here. That's a system of five main inter-dependent packages, plus docs which cross between packages and don't neatly fit into any single package. The whole thing is coordinated by this relatively simply makefile which in turn mostly relies on this script.

A lot of that script is general, and likely sufficiently generalisable that it could and should be internalised in package functions here, but we first need some other examples of usage to know how generally appilcable that workflow is. It'd be great in that context if you were to start using this package, so you could give feedback on how to improve it and make it more generally usable. Hopefully you do decide to use it, in which case we'll be happy to work with you to adapt to your specific needs 👍

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

2 participants