Generate API reference documentation #162
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
1ec5
commented
Oct 1, 2021
|
|
||
| jazzy \ | ||
| --config docs/jazzy.yml \ | ||
| --sdk macosx \ |
There was a problem hiding this comment.
As far as I can tell, jazzy doesn’t support compiling a single docset across multiple operating systems, so we have to choose one when building the module. Fortunately, Turf has very little variation between operating systems, so I’ve chosen macOS for simplicity. The only API-level differences are on Linux, but type aliases keep things pretty consistent.
Also linked Turf.js functions in readme to Turf.js demonstration page.
|
v2.0.0 will come with marked improvement in documentation coverage:
|
azarovalex
approved these changes
Oct 4, 2021
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Added a script to generate an API reference docset using jazzy. The script and jazzy configuration are based on that of MapboxDirections, except for the Mapbox branding. It just uses the default jazzy theme, which comes with a handy search box. For now, the docset will be published to mapbox.github.io using GitHub Pages like some other small projects in this GitHub organization.
Documented the rest of the public symbols. Updated some documentation comments that had been referring to symbols removed in v1.0.0. Added inline cross-references to each ported initializer, method, and property to indicate the Turf.js package and method it was ported from. Linked the readme to the Turf.js demonstration page, which is more user-friendly and gives a good conceptual understanding of the functionality.
Fixes #44.
/cc @mapbox/navigation-ios @mapbox/maps-ios @mapbox/docs