Skip to content

Commit ad0bd79

Browse files
minosktminoskt
committed
Use jazzy for docs
1 parent ffee4c9 commit ad0bd79

4 files changed

Lines changed: 17 additions & 63 deletions

File tree

‎.gitignore‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,4 +16,4 @@ profile
1616
*.moved-aside
1717
DerivedData
1818
.idea/
19-
Documentation
19+
docs/

‎CHANGELOG.md‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,12 @@
11
# Changelog
22

3-
### 0.6.0 ???
3+
### 0.6.0 (???, 2024)
44
- Added support for Network Connection sensor.
55
- Added support for Screen Brightness sensor.
66
- Added support for iOS 17 and Xcode 15.
77
- Renamed Battery sensor to BatteryStatus.
88
- Changed the minimum supported platform to iOS 12.
9+
- Replaced appledoc documentation with Jazzy.
910

1011
### 0.5.1 (September 20, 2018)
1112
- Added support for Heading sensor.

‎SensingKit.xcodeproj/project.pbxproj‎

Lines changed: 0 additions & 61 deletions
Original file line numberDiff line numberDiff line change
@@ -6,20 +6,6 @@
66
objectVersion = 63;
77
objects = {
88

9-
/* Begin PBXAggregateTarget section */
10-
CF39802B1DAE7AC500A7C36C /* Documentation */ = {
11-
isa = PBXAggregateTarget;
12-
buildConfigurationList = CF39802C1DAE7AC600A7C36C /* Build configuration list for PBXAggregateTarget "Documentation" */;
13-
buildPhases = (
14-
CF39802F1DAE7AE100A7C36C /* Build Documentation */,
15-
);
16-
dependencies = (
17-
);
18-
name = Documentation;
19-
productName = Documentation;
20-
};
21-
/* End PBXAggregateTarget section */
22-
239
/* Begin PBXBuildFile section */
2410
CF397F2A1DA9609C00A7C36C /* SensingKit.framework in Frameworks */ = {isa = PBXBuildFile; fileRef = CF397F201DA9609C00A7C36C /* SensingKit.framework */; };
2511
CF397F2F1DA9609C00A7C36C /* SensingKitTests.m in Sources */ = {isa = PBXBuildFile; fileRef = CF397F2E1DA9609C00A7C36C /* SensingKitTests.m */; };
@@ -646,10 +632,6 @@
646632
CreatedOnToolsVersion = 8.0;
647633
ProvisioningStyle = Automatic;
648634
};
649-
CF39802B1DAE7AC500A7C36C = {
650-
CreatedOnToolsVersion = 8.0;
651-
ProvisioningStyle = Automatic;
652-
};
653635
};
654636
};
655637
buildConfigurationList = CF397F1A1DA9609C00A7C36C /* Build configuration list for PBXProject "SensingKit" */;
@@ -667,7 +649,6 @@
667649
targets = (
668650
CF397F1F1DA9609C00A7C36C /* SensingKit */,
669651
CF397F281DA9609C00A7C36C /* SensingKitTests */,
670-
CF39802B1DAE7AC500A7C36C /* Documentation */,
671652
);
672653
};
673654
/* End PBXProject section */
@@ -692,23 +673,6 @@
692673
};
693674
/* End PBXResourcesBuildPhase section */
694675

695-
/* Begin PBXShellScriptBuildPhase section */
696-
CF39802F1DAE7AE100A7C36C /* Build Documentation */ = {
697-
isa = PBXShellScriptBuildPhase;
698-
buildActionMask = 2147483647;
699-
files = (
700-
);
701-
inputPaths = (
702-
);
703-
name = "Build Documentation";
704-
outputPaths = (
705-
);
706-
runOnlyForDeploymentPostprocessing = 0;
707-
shellPath = /bin/sh;
708-
shellScript = "#appledoc Xcode script\n# Start constants\ncompany=\"Kleomenis Katevas\";\ncompanyID=\"org.sensingkit\";\ncompanyURL=\"https://www.sensingkit.com\";\ntarget=\"iphoneos\";\noutputPath=\"${PROJECT_DIR}/Documentation\";\n# End constants\n\n/usr/local/bin/appledoc \\\n--project-name \"SensingKit-iOS\" \\\n--project-company \"${company}\" \\\n--company-id \"${companyID}\" \\\n--output \"${outputPath}\" \\\n--ignore .m \\\n--ignore ESSEddystone \\\n--ignore SKAbstractSensor.h \\\n--ignore SKMotionManager.h \\\n--ignore SKAccelerometer.h \\\n--ignore SKGyroscope.h \\\n--ignore SKMagnetometer.h \\\n--ignore SKDeviceMotion.h \\\n--ignore SKMotionActivity.h \\\n--ignore SKPedometer.h \\\n--ignore SKAltimeter.h \\\n--ignore SKBatteryStatus.h \\\n--ignore SKLocation.h \\\n--ignore SKiBeaconProximity.h \\\n--ignore SKEddystoneProximity.h \\\n--ignore SKMicrophone.h \\\n--ignore SKHeading.h \\\n--docset-platform-family \"${target}\" \\\n--logformat xcode \\\n--keep-intermediate-files \\\n--no-repeat-first-par \\\n--no-warn-invalid-crossref \\\n--no-create-docset \\\n--exit-threshold 2 \\\n\"${PROJECT_DIR}\"\n";
709-
};
710-
/* End PBXShellScriptBuildPhase section */
711-
712676
/* Begin PBXSourcesBuildPhase section */
713677
CF397F1B1DA9609C00A7C36C /* Sources */ = {
714678
isa = PBXSourcesBuildPhase;
@@ -998,22 +962,6 @@
998962
};
999963
name = Release;
1000964
};
1001-
CF39802D1DAE7AC600A7C36C /* Debug */ = {
1002-
isa = XCBuildConfiguration;
1003-
buildSettings = {
1004-
DEVELOPMENT_TEAM = 9T92P8D3FB;
1005-
PRODUCT_NAME = "$(TARGET_NAME)";
1006-
};
1007-
name = Debug;
1008-
};
1009-
CF39802E1DAE7AC600A7C36C /* Release */ = {
1010-
isa = XCBuildConfiguration;
1011-
buildSettings = {
1012-
DEVELOPMENT_TEAM = 9T92P8D3FB;
1013-
PRODUCT_NAME = "$(TARGET_NAME)";
1014-
};
1015-
name = Release;
1016-
};
1017965
/* End XCBuildConfiguration section */
1018966

1019967
/* Begin XCConfigurationList section */
@@ -1044,15 +992,6 @@
1044992
defaultConfigurationIsVisible = 0;
1045993
defaultConfigurationName = Release;
1046994
};
1047-
CF39802C1DAE7AC600A7C36C /* Build configuration list for PBXAggregateTarget "Documentation" */ = {
1048-
isa = XCConfigurationList;
1049-
buildConfigurations = (
1050-
CF39802D1DAE7AC600A7C36C /* Debug */,
1051-
CF39802E1DAE7AC600A7C36C /* Release */,
1052-
);
1053-
defaultConfigurationIsVisible = 0;
1054-
defaultConfigurationName = Release;
1055-
};
1056995
/* End XCConfigurationList section */
1057996
};
1058997
rootObject = CF397F171DA9609C00A7C36C /* Project object */;

‎generate-docs.sh‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
#!/bin/bash
2+
3+
jazzy \
4+
--clean \
5+
--output "docs" \
6+
--objc \
7+
--umbrella-header SensingKit/SensingKit.h \
8+
--framework-root $(pwd) \
9+
--sdk iphoneos \
10+
--author "Kleomenis Katevas" \
11+
--author_url "https://www.sensingkit.com" \
12+
--source-host github \
13+
--source-host-url "https://github.com/SensingKit/SensingKit-iOS" \
14+
--module "SensingKit-iOS"

0 commit comments

Comments
 (0)