4 ms·
Well, Sphinx (http://sphinx.pocoo.org/ http://sphinx.pocoo.org/) generates really good Python documentation. Perhaps if you were able to come up with something
by Skywing 16y ago
Well, Sphinx (http://sphinx.pocoo.org/ http://sphinx.pocoo.org/) generates really good Python documentation. Perhaps if you were able to come up with something that also generated nice documentation, but was language agnostic, that might be cool.
I'm also a fan of the recently popular annotated source code style of documentation. Although I feel like this style of documentation takes more effort to use.
If your service just hosted API docs, perhaps you could just make a platform that allows people to choose their API documentation platform, such as Sphinx, and somehow make it easier to generate it and deploy it on your servers. This might be enough of a reason for people to use your service. I wouldn't pay for it, though, unless you had some compelling reasons why I should. GitHub makes their basic project hosting free and it provides much more functionality and utility than a API documentation service might.
- matthodan 16y agoI hear you on Sphinx-- definitely looks like a great tool, though I haven't used it before. Do you know if Rails has something similar? Also, would you use sphinx to generate end-user docs (like the kind you find publicly available on Heroku, Twilio, SimpleGeo, PayPal, Hoptoad, etc.) or just internal docs? What level of control do you have over visibility of docs (i.e. can certain docs be private and others public?)?
- matthodan 16y agoHow about a service that took annotated source docs at commit and automatically updated a hosted public-facing documentation reference?