search

Feneric / doxypypy

A more Pythonic version of doxypy, a Doxygen filter for Python.
GNU General Public License v2.0
149 stars 49 forks source link

No installation nor usage instructions #2

Open SEWilco opened 11 years ago

SEWilco commented 11 years ago

There are no instructions on how to install nor use this. That will be particularly awkward for people unfamiliar with dOxygen filters.

Feneric commented 11 years ago

The project is still pretty young and I'm more focused on extending tests to verify its correct behavior at this stage. I'll get around to putting a bit more info on installing it etc. fairly soon. It is just a drop-in replacement for doxypy though and it has pointers to the documentation for it, so hopefully it won't be too horrible for new users in the interim.

shulegaa commented 11 years ago

+1

Impressive progress to date! Love the approach via leverage of Python's own abstract syntax tree (AST) module. I'd take a flier on putting a lot of my in-line python documentation in doxypypy format ... but I'm one of those folks that is unfamiliar with doxygen filters.

I suppose I can figure this modest little bit out. Darn. I'm sure getting spoiled by pip (and even apt-get) these days. When it is appropriate for this (small) barrier to adoption to get cleared away, I'd guess that the adoption rate of doxypypy will jump ~10x (or thereabouts). Thanks again for doxypypy.

Feneric commented 11 years ago

You're welcome. Glad you like it. Yeah, it's getting close to the point where it can go up on the Cheese Shop. Quite a few people are using it now with a fair degree of success.

Feneric commented 9 years ago

Finally got around to uploading it to the Cheese Shop...