Skip to content

Commit d2f0e3d

Browse files
committed
Add documentation/Makefile.
1 parent 8c576b5 commit d2f0e3d

File tree

3 files changed

+70
-0
lines changed

3 files changed

+70
-0
lines changed

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,3 +14,4 @@ xcuserdata
1414
DerivedData
1515
*.xcuserstate
1616
Carthage
17+
Documentation

.jazzy.yaml

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
custom_categories:
2+
- name: Attributed String Convertible
3+
children:
4+
- AttributedStringConvertible
5+
- NSAttributedString
6+
- String
7+
8+
- name: Attribute Functions
9+
children:
10+
- attribute(_:_:_:)
11+
- attributes(_:_:)
12+
13+
- name: Attribute Extensions
14+
children:
15+
- ColorType
16+
- FontType
17+
- Ligature
18+
- NSCursor
19+
- NSNumberConvertible
20+
- NSParagraphStyle
21+
- NSShadow
22+
- NSTextAttachment
23+
- NSUnderlineStyle
24+
25+
- name: Number Convertibles
26+
children:
27+
- CGFloat
28+
- Double
29+
- Float
30+
- Int
31+
- Int8
32+
- Int16
33+
- Int32
34+
- Int64
35+
- NSNumber
36+
- UInt
37+
- UInt8
38+
- UInt16
39+
- UInt32
40+
- UInt64

Makefile

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
XCODE_COMMAND=$(shell { command -v xctool || command -v xcodebuild; } 2>/dev/null)
2+
XCODE_GENERIC_FLAGS=-project 'Attributed.xcodeproj'
3+
XCODE_OSX_FLAGS=-scheme 'Attributed-OSX'
4+
XCODE_IOS_FLAGS=-scheme 'Attributed-iOS'
5+
6+
.PHONY: all clean docs test
7+
8+
all:
9+
$(XCODE_COMMAND) $(XCODE_GENERIC_FLAGS) $(XCODE_OSX_FLAGS) build
10+
$(XCODE_COMMAND) $(XCODE_GENERIC_FLAGS) $(XCODE_IOS_FLAGS) build
11+
12+
clean:
13+
$(XCODE_COMMAND) $(XCODE_GENERIC_FLAGS) $(XCODE_OSX_FLAGS) clean
14+
$(XCODE_COMMAND) $(XCODE_GENERIC_FLAGS) $(XCODE_IOS_FLAGS) clean
15+
16+
docs:
17+
jazzy \
18+
--clean \
19+
--author "Nate Stedman" \
20+
--author_url "http://natestedman.com" \
21+
--github_url "https://github.com/natestedman/Attributed" \
22+
--github-file-prefix "https://github.com/natestedman/Attributed/tree/master" \
23+
--module-version "0.1.0" \
24+
--xcodebuild-arguments -scheme,Attributed-OSX \
25+
--module Attributed \
26+
--output Documentation \
27+
28+
test:
29+
xcodebuild $(XCODE_GENERIC_FLAGS) $(XCODE_OSX_FLAGS) test

0 commit comments

Comments
 (0)