PDA

View Full Version : Will the new documentor be available for our own apps?



MikeRH
13 Jun 2016, 9:41 AM
Will it be made available to document our own apps as JSDuck was?

greg.barry
13 Jun 2016, 11:50 AM
MikeRH,

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.

Thanks!
Greg

greg.barry
14 Jun 2016, 6:38 AM
FYI, our new docs system is actually a two part system. The first part is called Doxi, and it's a source parser that rips through code and exports JSON files. That is available to anyone with a recent version of Cmd. The second part is a node processor that iterates through the JSON to output HTML. I believe the Doxi JSON can probably be consumed by any number of tools, application, or parser.

Thanks!
Greg

dotcs
20 Jun 2016, 11:33 AM
Greg, thanks for the explanation so far. Can you provide some details about the tooling? Is "doxi" a tool written by Sencha? Or is it an open source tool? And how can doxi be accessed through the new Sencha CMD cli? Previously with jsduck it was possible to extract and essentially re-build the Sencha Ext JS documentation by running something like


jsduck ext/classic/classic/src --output docs

So with the new documentation generator, how can we generate the underlying JSON files? I understand that the transformation tooling that allows to translate the JSON into HTML is not published yet, but can doxi already be used in such a way?

greg.barry
20 Jun 2016, 12:01 PM
Great questions!

Doxi is a Sencha created tool that can be accessed via the Sencha Cmd CLI.

You can generate docs by issuing the following command:


sencha doxi build

This command will expect to find a "project.doxi.json" file in the directory from which it's run. This file looks like a mix between the JSDuck config file and a Cmd generated application build profile. You can also include build targets in your CLI issuance if you want to have multiple build profiles within your project.doxi.json file. For instance:


sencha doxi build all-classes

You can specify different attributes for different profiles regarding:

Output location
Input location
Flattening (inheritance included)
Include Src
Auto Linking
Etc.
This is an experimental part of Sencha Cmd, so there's not a lot of documentation, but I will share our "project.doxi.json" file for Ext JS 6.0.2, so you can get an idea of how to set things are set up.

54721

Thanks!
Greg

twasink
20 Jun 2016, 9:25 PM
I believe the Doxi JSON can probably be consumed by any number of tools, application, or parser.

So... care to publish the generated JSON files as well as the generated HTML?

It doesn't strike me as particularly difficult to write an ExtJS application that provides the tabbed-documentation experience the old docs gave us; if the generated JSON was available, I'm sure someone in the community would give it a go.

greg.barry
21 Jun 2016, 8:24 AM
In the comment before yours, I gave instructions on how to generate the JSON files using Doxi, including the config file we use.

https://www.sencha.com/forum/showthread.php?311491-Will-the-new-documentor-be-available-for-our-own-apps&p=1137925&viewfull=1#post1137925

Let me know if anything is unclear and I'll try to walk through it further.

Thanks!
Greg

bclinton
24 Aug 2016, 5:39 AM
MikeRH,

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.

Thanks!
Greg

I'm looking forward to this being available.

feldtAtDimap
11 Apr 2017, 7:37 AM
What is the current situation now - eight months later ?

Perhaps it would be nice to have a simple configuration file to create a documentation for an ExtJS application following the standard folder structure ? That woulld be really helpful.

Marten

greg.barry
11 Apr 2017, 9:32 AM
Our first pass at our documentation software was rushed, and we created it with node, which we didn't have a lot of experience with. It was slow, unstable, and very very tied to our personal CI needs. We realized it wasn't going to be helpful for our users without some major modifications. (we as in the documentation team, not all of Sencha)

A couple months ago, we moved forward with our efforts to rebuild the doc processor with other users in mind. In this rebuild, we implemented multi-threading, smarter processing, fewer dependencies, a cleaner architecture so that users could modify and override as needed, etc. We are very happy with the results.

We are currently QA'ing the output for ExtReact and Ext JS 6.5. Once we're happy with the results, we'll rebuild all of our documentation with the new tool. At that point, we'll likely be ready to share the tool.

We really just want to be confident in the software before we release it.

Thanks!
Greg

dwahli
12 Jun 2017, 11:51 PM
Looking for the jsduck replacment and found this topic, but not sure what's the current situation.

We evaluate a migration from extjs 4.2 to 6.5 but we need a tool to extract the sources definition as JSON (as jsduck does).
Didn't try jsduck on extjs 6.5 sources yet, but it seems it's not the way to go as jsduck was replaced by something else.

In your last post you mention a new doc processor, is it the doxi command from the Sencha Cmd CLI 6.5 or is it something else ?
Can I use the current doxi command now and switch later to your new tool ? (the JSON outputs will be the same or very close ?)

Dominique

greg.barry
13 Jun 2017, 9:48 AM
You can can certainly use Doxi as it's part of Cmd.

It will comb through your source code and output JSON. It's half of the tool that we use. The other half is the JSON processor. Check out this thread for instructions on using Doxi.

https://www.sencha.com/forum/showthread.php?311491

Thanks!
Greg

valio
14 Jun 2017, 5:01 AM
Didn't try jsduck on extjs 6.5 sources yet, but it seems it's not the way to go as jsduck was replaced by something else.

You can still use JSDuck, if you don't need a docset for both toolkits and you're not using certain ES6 features (like template strings).

ui.community
14 Jul 2017, 1:49 AM
You can can certainly use Doxi as it's part of Cmd.

It will comb through your source code and output JSON. It's half of the tool that we use. The other half is the JSON processor. Check out this thread for instructions on using Doxi.

https://www.sencha.com/forum/showthread.php?311491

Thanks!
Greg

Hi Greg. I hope you can post a simple Ext project with a project.doxi.json as bolierplate.

greg.barry
18 Jul 2017, 11:52 AM
Hello!

In that other forum post I linked, you'll find full instructions and an example project.doxi.json file. Let me know if there's anything you're missing or if you need any further instructions. Here's a link directly to the post I'm talking about:

https://www.sencha.com/forum/showthread.php?311491

Thanks!
Greg

valio
12 Sep 2017, 12:35 AM
Our first pass at our documentation software was rushed, and we created it with node, which we didn't have a lot of experience with. It was slow, unstable, and very very tied to our personal CI needs. We realized it wasn't going to be helpful for our users without some major modifications. (we as in the documentation team, not all of Sencha)

A couple months ago, we moved forward with our efforts to rebuild the doc processor with other users in mind. In this rebuild, we implemented multi-threading, smarter processing, fewer dependencies, a cleaner architecture so that users could modify and override as needed, etc. We are very happy with the results.

We are currently QA'ing the output for ExtReact and Ext JS 6.5. Once we're happy with the results, we'll rebuild all of our documentation with the new tool. At that point, we'll likely be ready to share the tool.

We really just want to be confident in the software before we release it.

Thanks!
Greg

Is there a roadmap for the release of this doc tool from Sencha?
I'd like to know whether there is a roadmap so that I can go for an alternative (e.g. JSDuck) if there is no roadmap from Sencha or if there is, but it won't match our project schedule.
I would love to use the new tool, but without the html renderer framework, doxi is almost useless to me.

greg.barry
17 Sep 2017, 4:29 PM
Is there a roadmap for the release of this doc tool from Sencha?
I'd like to know whether there is a roadmap so that I can go for an alternative (e.g. JSDuck) if there is no roadmap from Sencha or if there is, but it won't match our project schedule.
I would love to use the new tool, but without the html renderer framework, doxi is almost useless to me.

Valio,

I don't want to disappoint you, but I don't think the documentation tool will make it to the public forum anytime soon.

If your project schedule is dependent on a documentation tool, I'd advise you to utilize JSDuck or something similar.

Thanks!
Greg

bogc
8 Jun 2018, 9:52 AM
Where is this at?

Thanks

greg.barry
27 Aug 2018, 8:00 AM
The team that created this tool has been gone from Sencha for over a year now. I can't speak for Sencha, but my guess would be that this particular project will not be made public since there is no-one left that had a hand in creating/using it. I'd recommend using Doxi to produce the JSON and then process that yourself, or look into other documentation tools that scan the source code and produce a web output. There are many options out there.

Thanks!
Greg

geopalam
21 Nov 2018, 9:10 AM
For anyone here who is using es6 features and still waiting for sencha to release a documentation tool you can still get your documentation working with jsduck

Follow these steps (you need to have npm installed)

1. run "npm init"
2. open package.json and add this to it:



"devDependencies": {
"babel-cli": "^6.26.0",
"babel-core": "^6.26.3"
}

and


"scripts": {
"build": "babel src -d build"
}

3. run "npm install"
4. run "touch .babelrc" and then edit that file and put in



{
"presets": ["env"]
}

5. copy your es6 code base into your npm project under the src directory
6. run "npm run build"
7. the es5 version of your code should now be in the build directory, you can use jsduck on this directory to output your documentation

For more options checkout: https://babeljs.io/