Skip to content

Commit

Permalink
[PR #2250] Added Jazzy docs for the release to work with GitHub Pages.
Browse files Browse the repository at this point in the history
* Add Jazzy for documentation

- Adds Jazzy as a developer dependency using Bundler
- Configures Jazzy for Alamofire

Jazzy repo: https://github.com/realm/jazzy

* Generate initial Jazzy docs

* Update readme to use Jazzy docs

Update the readme to point to GitHub Pages (when it is configured in repo's settings) for locally generated Jazzy docs instead of CocoaDocs as it is now deprecated.

* Update and lint configurations

Responding to PR feedback on #2250

- Adds spacing in array in `.jazzy.yaml` file
- Adds `.ruby-gemset` and `.ruby-version` files for Ruby version managers
- Adds `cocoapods` as an explicit Ruby dev dependency
- Updates Bundler lock to latest version of Bundler
- Updates Readme to use lower-case `ttps://alamofire.github.io`
  • Loading branch information
Aaron McTavish authored and cnoon committed Aug 22, 2017
1 parent e396a0e commit 318e590
Show file tree
Hide file tree
Showing 149 changed files with 84,618 additions and 2 deletions.
7 changes: 7 additions & 0 deletions .jazzy.yaml
@@ -0,0 +1,7 @@
author: Alamofire Software Foundation
author_url: http://alamofire.org/
github_url: https://github.com/Alamofire/Alamofire
module: Alamofire
output: docs
theme: fullwidth
xcodebuild_arguments: [-workspace, 'Alamofire.xcworkspace', -scheme, 'Alamofire iOS']
1 change: 1 addition & 0 deletions .ruby-gemset
@@ -0,0 +1 @@
Alamofire
1 change: 1 addition & 0 deletions .ruby-version
@@ -0,0 +1 @@
ruby-2.4.1
4 changes: 4 additions & 0 deletions Gemfile
@@ -0,0 +1,4 @@
source "https://rubygems.org"

gem "cocoapods"
gem "jazzy"
99 changes: 99 additions & 0 deletions Gemfile.lock
@@ -0,0 +1,99 @@
GEM
remote: https://rubygems.org/
specs:
CFPropertyList (2.3.5)
activesupport (4.2.9)
i18n (~> 0.7)
minitest (~> 5.1)
thread_safe (~> 0.3, >= 0.3.4)
tzinfo (~> 1.1)
claide (1.0.2)
cocoapods (1.3.1)
activesupport (>= 4.0.2, < 5)
claide (>= 1.0.2, < 2.0)
cocoapods-core (= 1.3.1)
cocoapods-deintegrate (>= 1.0.1, < 2.0)
cocoapods-downloader (>= 1.1.3, < 2.0)
cocoapods-plugins (>= 1.0.0, < 2.0)
cocoapods-search (>= 1.0.0, < 2.0)
cocoapods-stats (>= 1.0.0, < 2.0)
cocoapods-trunk (>= 1.2.0, < 2.0)
cocoapods-try (>= 1.1.0, < 2.0)
colored2 (~> 3.1)
escape (~> 0.0.4)
fourflusher (~> 2.0.1)
gh_inspector (~> 1.0)
molinillo (~> 0.5.7)
nap (~> 1.0)
ruby-macho (~> 1.1)
xcodeproj (>= 1.5.1, < 2.0)
cocoapods-core (1.3.1)
activesupport (>= 4.0.2, < 6)
fuzzy_match (~> 2.0.4)
nap (~> 1.0)
cocoapods-deintegrate (1.0.1)
cocoapods-downloader (1.1.3)
cocoapods-plugins (1.0.0)
nap
cocoapods-search (1.0.0)
cocoapods-stats (1.0.0)
cocoapods-trunk (1.2.0)
nap (>= 0.8, < 2.0)
netrc (= 0.7.8)
cocoapods-try (1.1.0)
colored2 (3.1.2)
escape (0.0.4)
ffi (1.9.18)
fourflusher (2.0.1)
fuzzy_match (2.0.4)
gh_inspector (1.0.3)
i18n (0.8.6)
jazzy (0.8.3)
cocoapods (~> 1.0)
mustache (~> 0.99)
open4
redcarpet (~> 3.2)
rouge (~> 1.5)
sass (~> 3.4)
sqlite3 (~> 1.3)
xcinvoke (~> 0.3.0)
liferaft (0.0.6)
minitest (5.10.3)
molinillo (0.5.7)
mustache (0.99.8)
nanaimo (0.2.3)
nap (1.1.0)
netrc (0.7.8)
open4 (1.3.4)
rb-fsevent (0.10.2)
rb-inotify (0.9.10)
ffi (>= 0.5.0, < 2)
redcarpet (3.4.0)
rouge (1.11.1)
ruby-macho (1.1.0)
sass (3.5.1)
sass-listen (~> 4.0.0)
sass-listen (4.0.0)
rb-fsevent (~> 0.9, >= 0.9.4)
rb-inotify (~> 0.9, >= 0.9.7)
sqlite3 (1.3.13)
thread_safe (0.3.6)
tzinfo (1.2.3)
thread_safe (~> 0.1)
xcinvoke (0.3.0)
liferaft (~> 0.0.6)
xcodeproj (1.5.1)
CFPropertyList (~> 2.3.3)
claide (>= 1.0.2, < 2.0)
colored2 (~> 3.1)
nanaimo (~> 0.2.3)

PLATFORMS
ruby

DEPENDENCIES
cocoapods
jazzy

BUNDLED WITH
1.15.4
4 changes: 2 additions & 2 deletions README.md
Expand Up @@ -3,7 +3,7 @@
[![Build Status](https://travis-ci.org/Alamofire/Alamofire.svg?branch=master)](https://travis-ci.org/Alamofire/Alamofire)
[![CocoaPods Compatible](https://img.shields.io/cocoapods/v/Alamofire.svg)](https://img.shields.io/cocoapods/v/Alamofire.svg)
[![Carthage Compatible](https://img.shields.io/badge/Carthage-compatible-4BC51D.svg?style=flat)](https://github.com/Carthage/Carthage)
[![Platform](https://img.shields.io/cocoapods/p/Alamofire.svg?style=flat)](http://cocoadocs.org/docsets/Alamofire)
[![Platform](https://img.shields.io/cocoapods/p/Alamofire.svg?style=flat)](https://alamofire.github.io/Alamofire)
[![Twitter](https://img.shields.io/badge/twitter-@AlamofireSF-blue.svg?style=flat)](http://twitter.com/AlamofireSF)
[![Gitter](https://badges.gitter.im/Alamofire/Alamofire.svg)](https://gitter.im/Alamofire/Alamofire?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)

Expand Down Expand Up @@ -45,7 +45,7 @@ Alamofire is an HTTP networking library written in Swift.
- [x] TLS Certificate and Public Key Pinning
- [x] Network Reachability
- [x] Comprehensive Unit and Integration Test Coverage
- [x] [Complete Documentation](http://cocoadocs.org/docsets/Alamofire)
- [x] [Complete Documentation](https://alamofire.github.io/Alamofire)

## Component Libraries

Expand Down

0 comments on commit 318e590

Please sign in to comment.