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

Add yard-tomdoc #101

Closed
wants to merge 1 commit into from
Closed

Conversation

jacobbednarz
Copy link

This adds the ability for developers to document their code using tomdoc
instead of the YARD format and have the generated output respect those
directives.

Fixes #62

This adds the ability for developers to document their code using tomdoc[1]
instead of the YARD format and have the generated output respect those
directives.

Fixes docmeta#62

[1]: http://tomdoc.org/
@jacobbednarz
Copy link
Author

@lsegal any thoughts on this one?

@lsegal
Copy link
Collaborator

lsegal commented Nov 24, 2015

As it stands, the plugin globally rewrites the default docstring parser across the entire YARD process, which means that it would potentially cause problems in rubydoc's current architecture. It's not safe to merge this in as is, unfortunately.

There isn't really a good general API to segregate the use of docstring parsers across runs of YARD.parse. Although yard-tomdoc works great in a single process or for a single project, it doesn't really work well in this specific context.

We would probably have to do some architecture work on rubydoc.info, stuff that is, arguably, long overdue, before we can handle a plugin like this on the site. @zapnap and I have been discussing reworking the site to use worker queues, possibly through docker, which would have plenty of other benefits in addition to the process segregation aspect. The problem, though, ultimately comes to the part where we are serving HTML via the renderer, and that's a slightly harder problem to solve (worker queues won't help there).

@jacobbednarz
Copy link
Author

no worries! closing this one off and will look at another option.

@jacobbednarz jacobbednarz deleted the add-yard-tomdoc branch November 27, 2015 23:14
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

Successfully merging this pull request may close these issues.

2 participants