SPT-1998 update code doc

surfstudio · Jun 3, 2024 · 5966160 · 5966160
1 parent aea6caf
commit 5966160
Show file tree

Hide file tree

Showing 2,558 changed files with 2,669 additions and 172,024 deletions.
diff --git a/Gemfile b/Gemfile
@@ -8,7 +8,6 @@ git_source(:github) do |repo_name|
 end if Gem::Version.new(Bundler::VERSION) < Gem::Version.new('2')
 
 gem 'xcpretty', "0.3.0"
-gem "jazzy", "0.14.2"
 
 plugins_path = File.join(File.dirname(__FILE__), 'fastlane', 'Pluginfile')
 eval_gemfile(plugins_path) if File.exist?(plugins_path)
diff --git a/Makefile b/Makefile
@@ -24,7 +24,12 @@ test:
 
 ## Created documentation by comments from code
 doc:
-	bundle exec jazzy --clean --build-tool-arguments -project,./NodeKit/NodeKit.xcodeproj,-scheme,NodeKit,-sdk,iphonesimulator --output "docs"
+	cd ./NodeKit && swift package --allow-writing-to-directory ../docs \
+    generate-documentation --target NodeKit \
+    --disable-indexing \
+    --transform-for-static-hosting \
+    --hosting-base-path NodeKit \
+    --output-path ../docs
 
 # COLORS
 GREEN  := $(shell tput -Txterm setaf 2)

diff --git a/NodeKit.podspec b/NodeKit.podspec
diff --git a/Package.swift b/Package.swift
@@ -17,6 +17,9 @@ let package = Package(
             targets: ["NodeKitMock"]
         ),
     ],
+    dependencies: [
+        .package(url: "https://github.com/apple/swift-docc-plugin", from: "1.0.0"),
+    ],
     targets: [
         .target(
             name: "NodeKitThirdParty",

diff --git a/README.md b/README.md
@@ -2,9 +2,7 @@
 
 [![GitHubActions Build Status](https://github.com/surfstudio/NodeKit/workflows/CI/badge.svg)](https://github.com/surfstudio/NodeKit/actions)
 [![codecov](https://codecov.io/gh/surfstudio/NodeKit/branch/master/graph/badge.svg)](https://codecov.io/gh/surfstudio/NodeKit)
-[![CocoaPods](https://img.shields.io/badge/pod-compatible-blue.svg)](https://github.com/surfstudio/NodeKit/blob/master/NodeKit.podspec)
 [![SPM Compatible](https://img.shields.io/badge/SPM-compatible-blue.svg)](https://github.com/apple/swift-package-manager)
-[![Documentation](https://surfstudio.github.io/NodeKit/badge.svg)](https://surfstudio.github.io/NodeKit/)
 
 Flexible and customizable network library
 
@@ -83,13 +81,6 @@ dependencies: [
 ]
 ```
 
-### CocoaPods
-
-Using Podfile:
-
-- Write `pod NodeKit`
-- Run `pod install` command
-
 ## Features
 
 - Swift Concurrency

diff --git a/TechDocs/Documentation.md b/TechDocs/Documentation.md
@@ -7,4 +7,4 @@
 - [Chains](/TechDocs/Chains.md)
 - [Logging](/TechDocs/Log/Log.md)
 - [NodeKitMock](/TechDocs/Testing/NodeKitMock.md)
-- [Code documentation](../docs/index.html)
+- [Code documentation](https://surfstudio.github.io/NodeKit/documentation/nodekit)
diff --git a/TechDocs/GettingStarted.md b/TechDocs/GettingStarted.md