Skip to content

Commit

Permalink
Install jazzy in the bundle
Browse files Browse the repository at this point in the history
  • Loading branch information
younata committed Dec 21, 2023
1 parent ebe9d80 commit 191031b
Show file tree
Hide file tree
Showing 3 changed files with 34 additions and 38 deletions.
1 change: 1 addition & 0 deletions Gemfile
Original file line number Diff line number Diff line change
Expand Up @@ -2,3 +2,4 @@
source "https://rubygems.org"

gem 'cocoapods', '~> 1.14'
gem 'jazzy', '~> 0.14'
23 changes: 23 additions & 0 deletions Gemfile.lock
Original file line number Diff line number Diff line change
Expand Up @@ -74,21 +74,43 @@ GEM
httpclient (2.8.3)
i18n (1.14.1)
concurrent-ruby (~> 1.0)
jazzy (0.14.4)
cocoapods (~> 1.5)
mustache (~> 1.1)
open4 (~> 1.3)
redcarpet (~> 3.4)
rexml (~> 3.2)
rouge (>= 2.0.6, < 5.0)
sassc (~> 2.1)
sqlite3 (~> 1.3)
xcinvoke (~> 0.3.0)
json (2.6.3)
liferaft (0.0.6)
mini_portile2 (2.8.5)
minitest (5.20.0)
molinillo (0.8.0)
mustache (1.1.1)
mutex_m (0.1.2)
nanaimo (0.3.0)
nap (1.1.0)
netrc (0.11.0)
open4 (1.3.4)
public_suffix (4.0.7)
redcarpet (3.6.0)
rexml (3.2.6)
rouge (4.2.0)
ruby-macho (2.5.1)
ruby2_keywords (0.0.5)
sassc (2.4.0)
ffi (~> 1.9)
sqlite3 (1.6.9)
mini_portile2 (~> 2.8.0)
typhoeus (1.4.0)
ethon (>= 0.9.0)
tzinfo (2.0.6)
concurrent-ruby (~> 1.0)
xcinvoke (0.3.0)
liferaft (~> 0.0.6)
xcodeproj (1.23.0)
CFPropertyList (>= 2.3.3, < 4.0)
atomos (~> 0.1.3)
Expand All @@ -102,6 +124,7 @@ PLATFORMS

DEPENDENCIES
cocoapods (~> 1.14)
jazzy (~> 0.14)

BUNDLED WITH
2.1.4
48 changes: 10 additions & 38 deletions script/build_docs.zsh
Original file line number Diff line number Diff line change
Expand Up @@ -8,41 +8,13 @@
# Jazzy: https://github.com/realm/jazzy/releases/latest
# Generates documentation using jazzy and checks for installation.

VERSION="0.14.3"

FOUND=$(jazzy --version)
LINK="https://github.com/realm/jazzy"
INSTALL="gem install jazzy"

if which jazzy >/dev/null; then
jazzy \
--clean \
--author "Nimble Contributors" \
--author_url "https://github.com/Quick/Nimble" \
--github_url "https://github.com/Quick/Nimble" \
--module "Nimble" \
--source-directory . \
--readme "README.md" \
--output docs/
else
echo "
Error: Jazzy not installed!
Download: $LINK
Install: $INSTALL
"
exit 1
fi

if [ "$FOUND" != "jazzy version: $VERSION" ]; then
echo "
Warning: incorrect Jazzy installed! Please upgrade.
Expected: $VERSION
Found: $FOUND
Download: $LINK
Install: $INSTALL
"
fi

exit
bundle exec jazzy \
--clean \
--author "Nimble Contributors" \
--author_url "https://github.com/Quick/Nimble" \
--github_url "https://github.com/Quick/Nimble" \
--module "Nimble" \
--source-directory . \
--readme "README.md" \
-x -scheme,Nimble \
--output docs/

0 comments on commit 191031b

Please sign in to comment.