Commit Graph

30 Commits

Author SHA1 Message Date
Nadia Barbosa
54fb5b046e [ios, macos] Update Jazzy theme (#15125)
* [ios, macos] Update Jazzy theme

module_version -> module-version

* Update platform/macos/scripts/document.sh
2019-07-17 13:02:30 -07:00
Jason Wray
6dc38c593a [ios, docs] Support custom jazzy header content 2019-02-01 13:39:36 -08:00
Jason Wray
2d5ae83882 [build, ios] Update jazzy to 0.9.5 2019-01-29 10:04:21 -08:00
Fabian Guerra
b53ea9b487 [ios] Fix jazzy building. 2019-01-28 13:17:50 -08:00
Jason Wray
67e5761e72 [ios] Update more URLs to docs.mapbox.com/ios 2019-01-25 11:57:45 -08:00
Nadia Barbosa
51f3842a28 [ios] Install node modules in document.sh 2018-08-23 09:06:35 -07:00
Jason Wray
5e213d0db1 [ios, build] Improve jazzy readme generation
- Include changelogs for all releases in the current semver minor series.
- Use template for jazzy readme.
2018-08-22 13:05:49 -04:00
Jason Wray
6fc0eb908b [ios, build] Postpone jazzy install for ios-release build 2018-07-03 15:47:49 -04:00
Jason Wray
1b3d8f990f [ios, build] Move iOS release builds to CircleCI 2018-03-12 17:56:06 -04:00
Jason Wray
50ee8daca1 [ios, build] Don't include docs for auto-installed jazzy 2017-10-10 11:45:12 -07:00
Minh Nguyễn
fc382f7108 [macos] Fixed broken images in DDS guide 2017-04-03 15:36:07 -07:00
Minh Nguyễn
0fac9d5674 [ios, macos] Added guide for working with GeoJSON 2017-01-04 21:39:08 -08:00
Minh Nguyễn
50ae3eb3c0 [ios, macos] Insert example code in original headers (#7569)
* [ios, macos] Removed extraneous code fences

* [ios] Streamlined example delimiters

Use test method names as names of example blocks and test method documentation comments as front matter for examples. Set off example blocks using a syntax similar to playground markup syntax. Avoid hard-coding indentation levels. Trigger Xcode build error when an error occurs in the script.

* [ios] Removed platform-specific code from examples

* [ios] Fixed logic error

The comment said 200 while the code said 1,500.

* [ios] Formalize build phase input

* [ios] Insert examples into original source documentation

Rewrote the example code insertion script to work on the original source files and overwrite any existing code examples on the same symbols. The script uses SourceKitten to find the documentation comment for the symbol named by the test method.

Replaced the Run Script build phase that runs the example code insertion script with a make rule that runs the same script. Inlined skeleton examples minus the contents of the code blocks.

* [ios] Fixed syntax error

* [ios] Ran ios-add-examples-to-docs

* [ios] Avoid touching unchanged headers

* [ios] Refactored example insertion script

* [ios] Point jazzy at original sources

* [ios] Invoke SourceKitten only once

* [ios] Look for methods as well as properties

* [ios] Thoroughly search for code blocks in doc comments

Refactored the example code insertion script to index test methods by their names, then recursively search the SourceKitten output for documentation comments that contain Swift code blocks, replacing each code block with the associated test method body.

* [ios, macos] Enabled example insertion for macOS

The example code insertion script is now platform-agnostic.

* [ios, macos] Fixed documentation example tests

Set the map view’s style to a minimal local JSON file. Wait for the style to finish loading before running each test. Corrected CGVector type.

* [ios, macos] Dry run mode

The output of this mode isn’t a good indicator of whether any files would’ve needed to be changed, because the presence of a conditional compilation block in one of the test methods means this script would always change and revert the corresponding comment.

* [ios] Fixed test failure

The iOS implementation of MGLMapView tries to show the Streets style by default even if no access token has been set. Avoid a race condition and frequent test failure by specifying the minimal style on initialization.

* [ios, macos] Ensure SourceKitten is installed before inserting example code

* [ios, macos] Tear down map view after each test

Keep map views from previous tests from hanging around, potentially obscuring the result of a subsequent test. Set the access token to a bogus token upfront for all style layer tests. Unified MGLStyle usage within MGLStyleTests.

* [ios, macos] Reinsert examples after generating runtime styling headers
2017-01-04 12:19:31 -08:00
Eric Wolfe
01717af59f [ios] Adds guides to documentation sidebar (#7488)
Initial set of guides focused on runtime styling
2017-01-03 14:40:14 -08:00
Eric Wolfe
9faa4af1c3 [ios] Add inline examples in documentation (#7337) 2016-12-21 10:22:13 -08:00
Maya Gao
7f67a2926d iOS jazzy theme improvements (#7422)
some small improvements to the theme
2016-12-16 16:11:47 -08:00
Tom MacWright
74f39c0120 [ios] [osx] Make theme configurable (#7420)
* Make theme configurable

* [ios][osx] Make jazzy theme configurable
2016-12-15 10:30:45 -08:00
Justin R. Miller
8ffd1f6925 [ios, macos] document custom API URL & add Info.plist guide (#6833)
Also support base URL nullability in order to use default value.
2016-11-01 10:29:33 -07:00
Jason Wray
23eaf6fb86 [ios] Don't specify Swift version for jazzy doc generation (#6377) 2016-09-19 15:43:45 -04:00
Minh Nguyễn
2bcc8749e3 [ios] Split release notes into sections by topic 2016-07-03 16:20:39 -07:00
Jason Wray
c75caa650b [ios] Update and bundle docs screenshot
- Don't use an absolute URL for the screenshot image, include the file instead.
- Add Sketch document for screenshot.
2016-07-01 14:45:45 -04:00
Jason Wray
bacf8eee70 [ios, macos] Add Mapbox Jazzy theme
- Based on Jazzy's "full width" theme.
- Add ellipsis to overlong items in navigation menu.
- Set minimum width for navigation menu.
- Use Open Sans font face.
- Inline GitHub header icon as SVG.
- Center images by default.
- Add GitHub SVG icon to 'show on github' link.
- Wrap overlong method names on class pages.
2016-07-01 14:44:51 -04:00
Minh Nguyễn
fd93cf969d [ios] Fixed jazzy build step
Fixed some regressions introduced in 9c9ff2d2d4 for #4802. A backslash was missing from a shell script, causing arguments to get dropped and output to go in the repo root. Paths in the jazzy configuration file needed to be updated so jazzy could find the headers.
2016-04-24 11:37:01 -07:00
Minh Nguyễn
9c9ff2d2d4 [ios, osx] Updated build system for jazzy
Consolidated NSValue categories to work around realm/jazzy#539. Documented MGLErrorCode. Moved jazzy configuration file into platform/ios/. Removed redundant include/Mapbox.h that was only being used by jazzy, now that the static frameworks’s umbrella header is based on that of the dynamic framework. Moved framework/Mapbox.h to include/Mapbox.h for consistency.
2016-04-22 12:31:42 -07:00
Minh Nguyễn
8cdb4f74e1 [ios] Fixed changelog processing
Fixed a regression introduced in #4466 in which the changelog is essentially empty.

Fixes #4469.
2016-03-25 12:24:14 -07:00
Minh Nguyễn
85297e2c6b [ios] Use current Swift version with jazzy
Fixes #4468.
2016-03-25 11:19:29 -07:00
John Firebaugh
13e2acbc75 [ios, osx] Consolidate remaining files in platform/{ios,osx} 2016-02-12 14:53:52 -08:00
Minh Nguyễn
eeeec862a2 [ios] Remove dependency on variable in package.sh
Fixes #3725.
2016-01-28 08:49:51 -08:00
Minh Nguyễn
f65ff9ef30 [ios] Split API index from package readme
The API index page serves a different purpose than the readme. It doesn’t need installation instructions, but it does need a brief What’s New section.
2016-01-22 14:45:58 -08:00
Minh Nguyễn
83deed6a88 [ios] make idocument
Split API documentation generation into a separate make target that can be run independently of building the SDK.
2016-01-22 14:45:58 -08:00