aws-cdk
aws-cdk copied to clipboard
aws
[docs]: Produce Dash version of API reference
Got this request from a customer over in the Dev Guide repo. https://github.com/awsdocs/aws-cdk-guide/issues/219
Dash is a native offline browser app for API documentation. It was originally developed for Mac but there are clones of it on other platforms. From a quick Google, it appears the DocSet build tools can accept HTML as input, so it might not be all that much work to support it.
Okay that's interesting and potentially worthwhile. Thanks for brining this up!
Hi! I saw that someone already did the heavy lifting: https://github.com/huyphan/aws-cdk-typescript-dash-docset/issues/1
On the Dash repo it was already requested to make a PR for the dash docset: https://github.com/Kapeli/Dash-User-Contributions/issues/2601
Maybe you can have a look to address some of the concerns that are mentioned in the first issue. Nevertheless, it would be really nice to have a dash docset available for the community.
We're getting really deep into CDK a lot (Python) and this would make things so much faster. The web docs are ok, but fuzzy searching for things rapidly doesn't really happen there, like it can in Dash.
Popping in to +1 this. The HTML scraping scripts in https://github.com/huyphan/aws-cdk-typescript-dash-docset no longer appear to be functional, would love to see a formally supported version of this for Python. doc2dash is supposed to be compatible with Sphinx but I wasn’t able to determine where the public Sphinx-generated API reference comes from.
I have created the PR Kapeli/Dash-User-Contributions#4262. After merging, everyone can download it from the Dash app.
The maintenance repository is yo-ga/dash-docset-aws-cdk-python
