rootstock icon indicating copy to clipboard operation
rootstock copied to clipboard

manubot as "in code" code-doc, deployed to github pages as manual?

Open novski opened this issue 6 years ago • 2 comments

It would be nice to see a $OWNER/$REPO/docs usage of manubot for "in-code" documentation and continuous deployment to github pages as manual, side by side with the code in $REPO...

novski avatar Dec 23 '19 19:12 novski

Interesting suggestion. To make sure I understand, the idea is that Manubot would be used to generate a manuscript that documents the codebase in $OWNER/$REPO, similar to how one would use sphinx or portray to generate code documentation. Is that correct?

This would be difficult to do in the current form because the repo must contain the manuscript content as well as supporting files like build scripts and assets. However, there has been discussion about making Manubot more standalone so that it doesn't require all of these supporting files in the repo. If that works, potentially this could be a new use case.

agitter avatar Dec 23 '19 21:12 agitter

Yes, that's the use case I'm thinking of.

novski avatar Dec 25 '19 08:12 novski