Page 1 of 2 12 LastLast
Results 1 to 10 of 18

Thread: Will the new documentor be available for our own apps?

  1. #1
    Sencha Premium Member
    Join Date
    Dec 2012
    Location
    Seattle, WA
    Posts
    409
    Answers
    33
    Vote Rating
    55
      2  

    Default Answered: Will the new documentor be available for our own apps?

    Will it be made available to document our own apps as JSDuck was?

  2. 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

  3. #2
    Sencha User
    Join Date
    Mar 2012
    Location
    Lawrence, KS
    Posts
    458
    Answers
    65
    Vote Rating
    92
      2  

    Default

    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

  4. #3
    Sencha User
    Join Date
    Mar 2012
    Location
    Lawrence, KS
    Posts
    458
    Answers
    65
    Vote Rating
    92
      2  

    Default

    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

  5. #4
    Sencha User
    Join Date
    Apr 2016
    Posts
    1
    Vote Rating
    2
      2  

    Default

    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

    Code:
    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?

  6. #5
    Sencha User
    Join Date
    Mar 2012
    Location
    Lawrence, KS
    Posts
    458
    Answers
    65
    Vote Rating
    92
      2  

    Default

    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:

    PHP Code:
    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:

    PHP Code:
    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.

    project.doxi.json.zip

    Thanks!
    Greg

  7. #6
    Sencha Premium Member twasink's Avatar
    Join Date
    Oct 2012
    Location
    Brisbane, Australia
    Posts
    122
    Answers
    4
    Vote Rating
    17
      1  

    Question

    Quote Originally Posted by greg.barry View Post
    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.

  8. #7
    Sencha User
    Join Date
    Mar 2012
    Location
    Lawrence, KS
    Posts
    458
    Answers
    65
    Vote Rating
    92
      1  

    Default

    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/showthr...=1#post1137925

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

    Thanks!
    Greg

  9. #8
    Sencha User bclinton's Avatar
    Join Date
    Nov 2007
    Posts
    305
    Answers
    3
    Vote Rating
    11
      0  

    Default

    Quote Originally Posted by greg.barry View Post
    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.

  10. #9
    Sencha Premium Member
    Join Date
    Sep 2014
    Posts
    87
    Answers
    1
    Vote Rating
    46
      0  

    Default

    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

  11. #10
    Sencha User
    Join Date
    Mar 2012
    Location
    Lawrence, KS
    Posts
    458
    Answers
    65
    Vote Rating
    92
      4  

    Default

    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

Page 1 of 2 12 LastLast

Similar Threads

  1. Are Sencha Touch Apps just Web Apps?
    By william.millington in forum Sencha Touch 2.x: Q&A
    Replies: 5
    Last Post: 16 Jun 2014, 11:50 AM
  2. [OPEN] [2.3.1a] iOS 7 home screen apps still losing status bar for production apps
    By Steffen Hiller in forum Sencha Touch 2.x: Bugs
    Replies: 2
    Last Post: 8 May 2014, 1:23 PM
  3. html 5 apps - what about packaged apps?
    By suzuki1100nz in forum Q&A
    Replies: 7
    Last Post: 17 Feb 2014, 12:13 AM
  4. Mobile HTML5 apps close to Native apps some day ?
    By debianw in forum Sencha Touch 2.x: Discussion
    Replies: 4
    Last Post: 12 Feb 2013, 11:42 AM
  5. Can run touch2 apps
    By kskrumpet in forum Sencha Touch 2.x: Q&A
    Replies: 8
    Last Post: 27 Dec 2012, 8:58 AM

Posting Permissions

  • You may not post new threads
  • You may not post replies
  • You may not post attachments
  • You may not edit your posts
  •