forked from mapbox/mapbox-navigation-ios
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request mapbox#140 from mapbox/erw-jazzy-docs
Add jazzy documentation
- Loading branch information
Showing
28 changed files
with
1,245 additions
and
0 deletions.
There are no files selected for viewing
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
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -8,3 +8,5 @@ xcuserdata | |
|
||
Carthage/Build | ||
Carthage/Checkouts | ||
/build | ||
/documentation |
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
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,9 @@ | ||
## Generating documentation locally | ||
|
||
Run `scripts/document.sh` | ||
|
||
## Update the documentation site: | ||
1. Clone [mapbox-navigation-ios](https://github.com/mapbox/mapbox-navigation-ios) to a mapbox-navigation-ios-docs folder alongside your MapboxDirections.swift clone, and check out the `gh-pages` branch. | ||
1. In your main MapboxDirections.swift clone, check out the release branch and run `OUTPUT=../mapbox-navigation-ios-docs/directions/0.9.1 scripts/document.sh`, where _0.9.1_ is the new SDK version. | ||
1. In mapbox-navigation-ios-docs, edit [directions/index.html](https://github.com/mapbox/mapbox-navigation-ios/blob/gh-pages/directions/index.html) and directions/docsets/Mapbox.xml to refer to the new SDK version. | ||
1. Commit and push your changes to the mapbox-navigation-ios `gh-pages` branch. |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,16 @@ | ||
module: MapboxDirections | ||
author: Mapbox | ||
author_url: https://www.mapbox.com/directions/ | ||
github_url: https://github.com/mapbox/MapboxDirections.swift | ||
dash_url: https://mapbox.github.io/mapbox-navigation-ios/directions/docsets/Mapbox.xml | ||
copyright: '© 2014–2017 [Mapbox](https://www.mapbox.com/). See [license](https://github.com/mapbox/MapboxDirections.swift/blob/master/LICENSE.md) for more details.' | ||
|
||
head: | | ||
<link rel='shortcut icon' href='https://www.mapbox.com/img/favicon.ico' type='image/x-icon' /> | ||
#skip_undocumented: Yes | ||
#hide_documentation_coverage: Yes | ||
|
||
# custom_categories: | ||
# - name: Guides | ||
# children: | ||
# - Storyboards |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,88 @@ | ||
/* Rouge Syntax Highlighting, Mapbox Base style | ||
------------------------------------------------------- */ | ||
.highlight .hll { background-color:#ffffcc } | ||
|
||
/* No Styling, Just Default: | ||
.highlight .nx, Normal Text | ||
.highlight .ni Name.Entity | ||
.highlight .nf Name.Entity | ||
.highlight .no Name.Constant | ||
*/ | ||
|
||
/* Comments */ | ||
.highlight .o, /* Operator */ | ||
.highlight .c, | ||
.highlight .c1, | ||
.highlight .cp, | ||
.highlight .cm { color:#999; font-style:italic; } | ||
.highlight .err { color:#F00000; background-color:#F0A0A0 } /* Error */ | ||
|
||
.highlight .k { color:#404040; font-weight:bold; } /* Keyword */ | ||
.highlight .css .k { font-weight:normal; } | ||
|
||
.highlight .cs { color:#404040; font-style:italic; } /* Comment.Special */ | ||
.highlight .gd { color:#A00000; } /* Generic.Deleted */ | ||
.highlight .ge { font-style:italic } /* Generic.Emph */ | ||
.highlight .gs { font-weight:bold; } /* Generic.Strong */ | ||
.highlight .gr { color:#FF0000; } /* Generic.Error */ | ||
.highlight .gh { color:#000080; } /* Generic.Heading */ | ||
.highlight .gi { color:#00A000; } /* Generic.Inserted */ | ||
.highlight .go { color:#808080; } /* Generic.Output */ | ||
.highlight .gp { color:#c65d09; } /* Generic.Prompt */ | ||
.highlight .gu { color:#800080; } /* Generic.Subheading */ | ||
.highlight .gt { color:#0040D0; } /* Generic.Traceback */ | ||
.highlight .kc { color:#D24400; } /* Keyword.Constant */ | ||
|
||
/* Keyword.Declaration | ||
* Keyword.Namespace | ||
* Keyword.Reserved */ | ||
.highlight .kd, | ||
.highlight .kn, | ||
.highlight .kr, | ||
.highlight .nt { color:#0B5A91; } /* Name.Tag */ | ||
|
||
/* Literal.Number */ | ||
.highlight .mh, | ||
.highlight .mo, | ||
.highlight .il, | ||
.highlight .mi, | ||
.highlight .kt, | ||
.highlight .mf, | ||
.highlight .nl, /* Name.Label */ | ||
.highlight .na, /* Name.Attribute */ | ||
.highlight .m { color:#0C9DC2; } /* Keyword.Type */ | ||
.highlight .kp { color:#0080f0; } /* Keyword.Pseudo */ | ||
|
||
.highlight .nc { color:#DF6637; } /* Name.Class */ | ||
.highlight .css .nc { color:#75A21C; } | ||
|
||
.highlight .nd { color:#505050; } /* Name.Decorator */ | ||
.highlight .ne { color:#F00000; } /* Name.Exception */ | ||
|
||
.highlight .nn { color:#0e84b5; } /* Name.Namespace */ | ||
|
||
.highlight .nf, /* Name.Function */ | ||
.highlight .nv { color:#003060; } /* Name.Variable */ | ||
.highlight .ow { color:#404040; } /* Operator.Word */ | ||
.highlight .w { color:#bbbbbb; } /* Text.Whitespace */ | ||
.highlight .sc { color:#8080F0; } /* Literal.String.Char */ | ||
.highlight .sd { color:#D04020; } /* Literal.String.Doc */ | ||
|
||
/* Name.Builtin / Name.Builtin.Pseudo */ | ||
.highlight .bp, | ||
.highlight .nb { color:#007020; } | ||
|
||
/* Literal.String */ | ||
.highlight .s, | ||
.highlight .sh, | ||
.highlight .sb, | ||
.highlight .s1, | ||
.highlight .sr, | ||
.highlight .se { color:#75A21C; } | ||
|
||
.highlight .si { background-color:#eee; } /* Literal.String.Interpol */ | ||
.highlight .p { color:#444444; } /* Normal Text */ | ||
.highlight .ss { color:#f0c080; } /* Literal.String.Symbol */ | ||
.highlight .vc { color:#c0c0f0; } /* Name.Variable.Class */ | ||
.highlight .vg { color:#f08040; } /* Name.Variable.Global */ | ||
.highlight .vi { color:#a0a0f0; } /* Name.Variable.Instance */ |
Oops, something went wrong.