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

Documentation coverage #666

Open
cope opened this issue Feb 28, 2017 · 8 comments
Open

Documentation coverage #666

cope opened this issue Feb 28, 2017 · 8 comments

Comments

@cope
Copy link

cope commented Feb 28, 2017

Any plans on adding documentation coverage reports, like this one from esdoc?

'Cause that would be awesome!

@nene
Copy link
Member

nene commented Feb 28, 2017 via email

@michaelkantor
Copy link

Is there a successor? Is there something different that Sencha is now recommending? I've been using this for 3 years and remain pretty happy with it, but always happy to look at other projects.

@cope
Copy link
Author

cope commented Mar 10, 2017

What is Sencha using for documentation now?

@nene
Copy link
Member

nene commented Mar 11, 2017

My guess is that they're still using JSDuck under the hood to extract docs from source code, but have built a new UI for showing the docs.

But these are just guesses. I'm not in contact with Sencha any more.

@valioDOTch
Copy link

valioDOTch commented Mar 13, 2017

It appears this forum thread is related to this question
https://www.sencha.com/forum/showthread.php?311491

greg.barry: I'd love for the new docs software to be utilized by the community. That said, it's not currently set up to be shared outside of Sencha yet. We'll have to have some internal dialogue about the best way to potentially distribute this for other developers to use.

@valioDOTch
Copy link

PS: it appears there is some undocumented tool available via SenchaCmd called doxi
https://www.sencha.com/forum/showthread.php?311491-Will-the-new-documentor-be-available-for-our-own-apps&p=1137925&viewfull=1#post1137925
figuring out the details now for the config file...
project.doxi.json.zip

@michaelkantor
Copy link

Yeah; I saw that. However, it only outputs JSON, and leaves it to you to build the HTML. I rather like the JSDuck HTML; its part of why I use it (I'm not developing using a sencha JS framework). I don't currently have time budgeted to design and build an entire HTML generator that is as good. This project still works; hopefully they'll have open sourced everything before this starts to break down.

@valioDOTch
Copy link

The problem I have with JSDuck currently is that there's no new release which would fix some bugs like #491 :-(

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

No branches or pull requests

4 participants