I’ve got some great news for those of you who use Dash from Kapeli to view your technical documentation. Long story short, I’ve been working on getting the Xojo API2 docs into Dash for quite some time now and it’s finally here!
Here are the steps to install the new docset…
- Go to Dash
- Open the Settings
- Go to the Downloads tab
- Click on User Contributed in the left hand pane
- Search for Xojo
- The first listing there will be Xojo
- Press Download or the popup arrow to view that it’s 2023r4
One thing to note is that as part of the generation, I disabled the left navigation bar that is normally seen in the HTML Xojo docs as navigation is covered by Dash itself.
For those who might be interested in the journey to get here, I’ll elaborate. Being a full time Dash user, just like everyone else I’ve been relegated to the old API1 docsets. In mid-August of this year Bogdan at Kapeli rolled out a new Docset Generator to automatically create your own docset based upon an HTML source. I put it through its paces with the latest Xojo API2 documentation at the time, but it didn’t produce the result I was looking for.
Towards the end of the month I reached out to Bogdan and asked if you could update his internal docsets of Xojo to API2 and I noted that things had switched over to Sphinx for the HTML generation. Then towards the end of November a new version of Dash rolled out and lo and behold, it included support for Sphinx within the Docset Generator.
I got to working on a User Contributed but hosted by Kapeli docset. With lots of changes and back and forth with Bogdan over the holidays, the final hurdle was some kind of an index bug in the Sphinx side of the Docset Generator. He just fixed this yesterday, I recreated the docset last night and early this morning the Docset went live.
1 post - 1 participant