Merge pull request #140 from surfstudio/SPT-1998-generate-doc

SPT-1998 Последние правки + генерация swift-docc

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)

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)

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",

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
 
@@ -13,6 +11,14 @@ Flexible and customizable network library
   <img src="TechDocs/Header.svg">
 </p>
 
+## About
+
+The NodeKit library enables rapid and easy creation of requests of varying complexity. The system operates on the principle of asynchronous data transformation, wherein nodes are interconnected to form a chain that transforms input data into a server response.
+
+![All text](TechDocs/NodeKitHeader.svg)
+
+Such an approach allows us to flexibly adapt to a wide range of requirements.
+
 ## Build request using Swift Concurrency
 
 ```Swift
@@ -56,14 +62,6 @@ func credentialsPublisher(for authModel: AuthModel) -> AnyPublisher<NodeResult<C
 
 ```
 
-## About
-
-The NodeKit library enables rapid and easy creation of requests of varying complexity. The system operates on the principle of asynchronous data transformation, wherein nodes are interconnected to form a chain that transforms input data into a server response.
-
-![All text](TechDocs/NodeKitHeader.svg)
-
-Such an approach allows us to flexibly adapt to a wide range of requirements.
-
 ## Installation
 
 ### Swift Package Manager
@@ -83,13 +81,6 @@ dependencies: [
 ]
 ```
 
-### CocoaPods
-
-Using Podfile:
-
-- Write `pod NodeKit`
-- Run `pod install` command
-
 ## Features
 
 - Swift Concurrency
@@ -102,6 +93,7 @@ Using Podfile:
 - Comprehensive Unit and Integration Test Coverage
 - Mock target for Unit tests
 - [Documentation](TechDocs/Documentation.md)
+- [Code documentation](https://surfstudio.github.io/NodeKit/documentation/nodekit)
 
 ## Contributing
 

TechDocs/Documentation.md

@@ -7,4 +7,3 @@
 - [Chains](/TechDocs/Chains.md)
 - [Logging](/TechDocs/Log/Log.md)
 - [NodeKitMock](/TechDocs/Testing/NodeKitMock.md)
-- [Code documentation](../docs/index.html)