search

ropenscilabs / r2readthedocs

Convert R package documentation to a 'readthedocs' website
https://docs.ropensci.org/r2readthedocs/
15 stars 0 forks source link

documenting multiple R packages in one rtd site #14

Open erikriverson opened 1 year ago

erikriverson commented 1 year ago

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 commented 1 year ago

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 :+1: