-
Notifications
You must be signed in to change notification settings - Fork 92
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
Documentation for RDF.rb in iRuby notebooks? #294
Comments
Seems like an interesting idea. Right now, documentation references rubydoc.info, which is updated periodically from built-in yardoc tags, and having the documentation be derived from embedded yardoc is a big plus. I don't know how Jupyter works, but I'd be dis-inclined to maintain separate source for this that was divorced from the actual Ruby source, but the prospect of working examples in the documentation is intriguing. Note that most examples have duplicates in the specs, so there shouldn't be too many examples that fail. If so, that's obviously a bug which should be addressed. I certainly am open to considering this, though, and we should continue the conversation. |
I wanted to suggest that documentation for RDF.rb be moved into iRuby notebooks -- i.e., Jupyter notebooks running the Ruby kernel.
Github now supports the rendering of Jupyter notebooks in the browser (see my gist of some notes about Ruby). Some advantages of putting documentation into Jupyter:
jupyter nbconvert
to convert the documentation into HTML, PDF, or one-cell-at-a-time Powerpoint-like presentations.The text was updated successfully, but these errors were encountered: