github hosted docs have a link to install in dash, but no generated docset
heckj opened this issue · 2 comments
Expected behavior
When I was browsing the docs at https://apple.github.io/swift-metrics/docs/current/CoreMetrics/index.html, I noticed a link to install the docs as a docset into Dash. Sounded good for offline reading, so I clicked it - but the processing failed. As I dug in, it became clear that whatever is generating the documentation is not including the docset in what gets sent into gh-pages branch, which reflects through these docs.
I'm not sure if not including the docset was intentionally, or a miss somewhere - but if it's not intended to be included, the theme files for Jazzy should likely be tweaked to remove the "install into Dash" thing that's displayed by default.
If possible, minimal yet complete reproducer code (or URL to code)
- github hosted page https://apple.github.io/swift-metrics/docs/current/CoreMetrics/index.html
- expected docset URL: https://apple.github.io/swift-metrics/docs/1.2.1/CoreMetrics/docsets/CoreMetrics.xml
- which should match to branch
gh-pagesand the path:docs/1.2.1/CoreMetrics/docsets/CoreMetrics.xmldocs/1.2.1/CoreMetrics/exists, but nothing further ongh-pages
SwiftMetrics version/commit hash
Swift & OS version (output of swift --version && uname -a)
n/a, but for completeness sake:
Apple Swift version 5.2 (swiftlang-1103.0.32.1 clang-1103.0.32.29)
Target: x86_64-apple-darwin19.4.0
Darwin greyberry.local 19.4.0 Darwin Kernel Version 19.4.0: Wed Mar 4 22:28:40 PST 2020; root:xnu-6153.101.6~15/RELEASE_X86_64 x86_64
Great eyes!
If this gets a 👍, it'll also be worth it for someone in the community to evaluate other projects since they'll benefit from the fix too.
It's a simple one-liner, so I went ahead and made a PR for it as well: apple/swift-nio#1478