Skip to content
This repository was archived by the owner on Aug 8, 2023. It is now read-only.

allow appledoc upgrade #2117

Closed
incanus opened this issue Aug 18, 2015 · 4 comments
Closed

allow appledoc upgrade #2117

incanus opened this issue Aug 18, 2015 · 4 comments
Labels
build documentation iOS Mapbox Maps SDK for iOS

Comments

@incanus
Copy link
Contributor

incanus commented Aug 18, 2015

Currently we require appledoc 2.2v963 exactly for iOS docs generation. Is this still the case? If not, let's fix that so we can move on.

@incanus incanus added iOS Mapbox Maps SDK for iOS build labels Aug 18, 2015
@1ec5
Copy link
Contributor

1ec5 commented Aug 18, 2015

Last I checked, the holdup is that newer versions of appledoc come with templates that mimick Apple’s 2014-era docsets. Those templates require JavaScript to work correctly, but Xcode’s Documentation window seems to disallow JavaScript in third-party docsets. This won’t be an issue for the online documentation but will be for those who install the docset in Xcode (which I gather will be relatively few people).

I’d much prefer that we come up with new templates, like the ones used for Mapbox GL JS documentation.

@1ec5
Copy link
Contributor

1ec5 commented Dec 6, 2015

It’s more likely that we’ll end up switching to jazzy: #3203.

@1ec5
Copy link
Contributor

1ec5 commented Dec 16, 2015

Bitrise is running appledoc 2.2.1. I just upgraded my machine from 2.2.0 and the templates are broken, which means we’ve been building broken documentation on Bitrise all this time. 2.2.1 comes with an impressive 58 commits.

@1ec5
Copy link
Contributor

1ec5 commented Dec 16, 2015

The template breakage is tomaz/appledoc#561.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
build documentation iOS Mapbox Maps SDK for iOS
Projects
None yet
Development

No branches or pull requests

2 participants