yii2-apidoc icon indicating copy to clipboard operation
yii2-apidoc copied to clipboard

Add new template for running yii2-apidoc on a user-submitted project

Open jcherniak opened this issue 8 years ago • 12 comments
trafficstars

Q A
Is bugfix? no
New feature? yes
Breaks BC? no
Tests pass? yes
Fixed issues #131

jcherniak avatar Oct 29 '17 03:10 jcherniak

It works for me!

ricpelo avatar Nov 06 '17 21:11 ricpelo

It works good, but IMHO it isn't a perfect solution. The navigation sidebar never displays app\* and yii\* classes at the same time. It could be great if all the classes of app and yii namespaces were displayed together in the navigation sidebar.

ricpelo avatar Nov 06 '17 22:11 ricpelo

@ricpelo - Do you want yii namespaces in a custom project? I'd think not as it would make the sidebar be very crowded. I used this to generate docs for Craft CMS 3, which already has a ton of namespaces and classes. I'd think you wouldn't want the yii classes there.

jcherniak avatar Nov 06 '17 22:11 jcherniak

@jcherniak - First of all, thank you for your code! It works for me, as I said before. Maybe you're right: I only tested with a-few-classes project but with tons of classes could be overkill to have both app and yii namespaces at the same time.

ricpelo avatar Nov 06 '17 22:11 ricpelo

Hi! Will this PR be merged for 2.0.7 release (or maybe before :))? Thanks!

ricpelo avatar Nov 28 '17 10:11 ricpelo

Any chance this can be merged?

jcherniak avatar Feb 21 '18 22:02 jcherniak

Yes, please. I've used it for months and it works great, IMO.

ricpelo avatar Feb 22 '18 09:02 ricpelo

We need @cebe here.

samdark avatar Feb 22 '18 11:02 samdark

Any chance this can be merged now? Looks like @cebe made a few changes, so it would be nice to get this into core.

jcherniak avatar Oct 23 '18 10:10 jcherniak

@cebe @samdark @arogachev is this PR going to be merged or should it be closed?

mtangoo avatar Aug 03 '23 07:08 mtangoo

@mtangoo I'd get this one in. Would be great if you'll test it with custom project.

samdark avatar Aug 18 '23 08:08 samdark

I will find time and test it. Wanted to be sure there's desire to merge it in

mtangoo avatar Aug 18 '23 09:08 mtangoo