I’ve been diving deep into the SketchUp C++ API recently (huge thanks to TommyKaneko for the wrapper, it’s been a lifesaver).
In an effort to speed up my own production workflow, I’ve been refactoring parts of the SketchUp API documentation into Markdown. I’ve found that having it in an interconnected Obsidian vault makes it a lot easier for me to search, link concepts, and use alongside AI assistants.
I’d love to make this Markdown version public for other devs who prefer that format, but I want to be 100% respectful of the work the SketchUp team has already done. My goal is to supplement the official docs, not replace them, and I’d obviously include all the original credits and links back to the official SketchUp Developer site.
Does the team or the community have any objections to me sharing this? Just wanted to check in here before putting anything on GitHub to make sure I’m following best practices.
Yea, the current docs are output using doxygen and are a pain to navigate. Also the functions are listed in implementation order instead of alpha order.
Are you doing your markdown conversion manually with Obsidian ?
I would think it may be easier to use YARD (or a similar doc generator) to process the C API header files into better navigable web pages.
I have fully migrated and wrote script to address those pains before writing this post (like addressing tables, annotation, etc. on their doxygen)
I am not very familiar with alternatives on documentation, but I use quartz on my personal/internal docs (which based on Obsidian), I will look into YARD then!
I also still wondering where should I contact SketchUp directly in regards to this particular case.
The C++ wrapper is open source so you can make a PR for that to enable XML output (or clone it and generate it yiourself locally).
If the C API docs are more useful, creating a feature request thread in the extension developer support area of the forum describing that you want SketchUp to publish doxygen XML output and why would be something we could point people to internally.
I need to argue that this subcategory is the correct place in the forums for this request. And isn’t this topic enough of a request?
Extra to this forum, the official SketchUp API Issue Tracker would be another proper place for a request that can be tracked better by the SketchUp Extensibility Team.
This sub-category is for “If you’re working creating importers or exporters for SketchUp”
I didn’t mean the Extensions category by name (that’s why I said area), I was on a phone and you can’t see all the categories from the posting screen & couldn’t remember all the specific names, I have edited to fix that.
No, because I think that a title of “Refactoring API documentation for personal workflow (Obsidian/Markdown)” is not a good match for the request I suggested, Something along the lines of “Can SketchUp please publish XML output from Doxygen for the C API”, if seen on the page, is more likely for somebody to think “sure I can look into that”.
Actually not anymore. It was originally when it was a C++ SDK. But since it was converted to C and made available also as a live C API, this category is for any specific use of the C API.
(The name of the subcategory was never changed, i.e., the API is now also for LayOut files.)
Hi @DanRathbun
I appreciate your comments on this topic. At present there aren’t any immediate plans to change the way that we publish our API documentation. Having your thoughts logged means that it is something we may consider in future.
It wasn’t me that made the request. I think the OP was aiming at individual use, similar to how there are GitHub repos for those wanting to locally generate Ruby API docs using YARD.
my requests was sharing my personal experience (and then) publishing my own version of sketchup C API documentations (via markdown) and is it okay if I publish it with full credits to the Sketchup (and the community/developer and the SDK)
it is for individual use as of now, but if permitted, I’d be happy to share to the community, or push it to production.
“Can SketchUp please publish XML output from Doxygen for the C API
but rather I am here to express my feeling and share my experience and want to contribute to the other developers that might prefer portability or flexibility in reading the official and documenting their own findings. and I was not really feel like this is a noteworthy issue (since fundamentally this is not an issue in general, just preference) if this was issued on the api-issue-trakcer
also I wasn’t asking about the xml output, I did download all the html pages myself, and pattern-matching of the tables/headers/links to other page. (I did use AI to automate process on the C API to then creates me the markdown version of it) I already did it. and also automate the process if there is update on the C API so then I can reprocess it to markdown, again. I am here to share this but first need some permission if it is allowed (if not that is fine, at the very least I know the answer)
When false information is posted (even when based upon old information,) I’ll call it out because we have “dumb” AIs that treat anything posted as gospel truth.
The About description and the subcategory name should be brought up to date. Since this forum was setup, the “old” C++ SDK was retired and the new C API introduced. Even later, SketchUp allowed the C API to used in “Live” mode within SketchUp.
It is not relevant to to the Ruby API. It is not aimed at end user extensions. It is aimed at developers using the C API in either C or C++, standalone or Live use.