Skip to content

armgit / xtool

Public Imported from GitHub
0

Cross-platform Xcode replacement. Build and deploy iOS apps with SwiftPM on Linux, Windows, macOS.

More DocC improvements (#65)

Kabir Oberai26e076b95f6b
diff --git a/.spi.yml b/.spi.yml
deleted file mode 100644
index fadcfb8..0000000
--- a/.spi.yml
+++ /dev/null
@@ -1,14 +0,0 @@
-version: 1
-builder:
- configs:
- - scheme: xtool
- platform: macosSpm
- documentation_targets:
- - xtool
- - scheme: xtool
- platform: macosXcodebuild
- - scheme: xtool
- platform: linux
- image: kabiroberai/xtool-dev:latest
- - scheme: XKit
- platform: ios
diff --git a/Netlify/.gitignore b/Documentation/.gitignore
similarity index 100%
rename from Netlify/.gitignore
rename to Documentation/.gitignore
diff --git a/Documentation/build.sh b/Documentation/build.sh
new file mode 100755
index 0000000..0e16787
--- /dev/null
+++ b/Documentation/build.sh
@@ -0,0 +1,26 @@
+#!/bin/bash
+
+set -euo pipefail
+
+cd "$(dirname "$0")"
+
+rm -rf docs
+
+if type -p xcrun &>/dev/null; then
+ docc="$(xcrun -f docc)"
+else
+ docc="docc"
+fi
+
+if [[ $# == 0 ]]; then
+ command="convert"
+elif [[ $# == 1 && ( "$1" == "preview" || "$1" == "convert" ) ]]; then
+ command="$1"
+else
+ echo "Usage: $0 [convert|preview]"
+ exit 1
+fi
+
+"$docc" "$command" xtool.docc \
+ --experimental-enable-custom-templates \
+ --output-path docs
diff --git a/Sources/XToolDocs/Documentation.docc/Control.md b/Documentation/xtool.docc/Control.md
similarity index 100%
rename from Sources/XToolDocs/Documentation.docc/Control.md
rename to Documentation/xtool.docc/Control.md
diff --git a/Sources/XToolDocs/Documentation.docc/First-app-code/build-1a.sh b/Documentation/xtool.docc/First-app-code/build-1a.sh
similarity index 100%
rename from Sources/XToolDocs/Documentation.docc/First-app-code/build-1a.sh
rename to Documentation/xtool.docc/First-app-code/build-1a.sh
diff --git a/Sources/XToolDocs/Documentation.docc/First-app-code/build-1b.sh b/Documentation/xtool.docc/First-app-code/build-1b.sh
similarity index 100%
rename from Sources/XToolDocs/Documentation.docc/First-app-code/build-1b.sh
rename to Documentation/xtool.docc/First-app-code/build-1b.sh
diff --git a/Sources/XToolDocs/Documentation.docc/First-app-code/build-2.sh b/Documentation/xtool.docc/First-app-code/build-2.sh
similarity index 100%
rename from Sources/XToolDocs/Documentation.docc/First-app-code/build-2.sh
rename to Documentation/xtool.docc/First-app-code/build-2.sh
diff --git a/Sources/XToolDocs/Documentation.docc/First-app-code/build-3.sh b/Documentation/xtool.docc/First-app-code/build-3.sh
similarity index 100%
rename from Sources/XToolDocs/Documentation.docc/First-app-code/build-3.sh
rename to Documentation/xtool.docc/First-app-code/build-3.sh
diff --git a/Sources/XToolDocs/Documentation.docc/First-app-code/edit-2.swift b/Documentation/xtool.docc/First-app-code/edit-2.swift
similarity index 100%
rename from Sources/XToolDocs/Documentation.docc/First-app-code/edit-2.swift
rename to Documentation/xtool.docc/First-app-code/edit-2.swift
diff --git a/Sources/XToolDocs/Documentation.docc/First-app-code/edit-4.swift b/Documentation/xtool.docc/First-app-code/edit-4.swift
similarity index 100%
rename from Sources/XToolDocs/Documentation.docc/First-app-code/edit-4.swift
rename to Documentation/xtool.docc/First-app-code/edit-4.swift
diff --git a/Sources/XToolDocs/Documentation.docc/First-app-code/rerun-5a.sh b/Documentation/xtool.docc/First-app-code/rerun-5a.sh
similarity index 100%
rename from Sources/XToolDocs/Documentation.docc/First-app-code/rerun-5a.sh
rename to Documentation/xtool.docc/First-app-code/rerun-5a.sh
diff --git a/Sources/XToolDocs/Documentation.docc/First-app-code/rerun-5b.sh b/Documentation/xtool.docc/First-app-code/rerun-5b.sh
similarity index 100%
rename from Sources/XToolDocs/Documentation.docc/First-app-code/rerun-5b.sh
rename to Documentation/xtool.docc/First-app-code/rerun-5b.sh
diff --git a/Sources/XToolDocs/Documentation.docc/First-app-code/rerun-6.sh b/Documentation/xtool.docc/First-app-code/rerun-6.sh
similarity index 100%
rename from Sources/XToolDocs/Documentation.docc/First-app-code/rerun-6.sh
rename to Documentation/xtool.docc/First-app-code/rerun-6.sh
diff --git a/Sources/XToolDocs/Documentation.docc/First-app-code/template-1a.sh b/Documentation/xtool.docc/First-app-code/template-1a.sh
similarity index 100%
rename from Sources/XToolDocs/Documentation.docc/First-app-code/template-1a.sh
rename to Documentation/xtool.docc/First-app-code/template-1a.sh
diff --git a/Sources/XToolDocs/Documentation.docc/First-app-code/template-1b.sh b/Documentation/xtool.docc/First-app-code/template-1b.sh
similarity index 100%
rename from Sources/XToolDocs/Documentation.docc/First-app-code/template-1b.sh
rename to Documentation/xtool.docc/First-app-code/template-1b.sh
diff --git a/Sources/XToolDocs/Documentation.docc/First-app-code/template-2a.sh b/Documentation/xtool.docc/First-app-code/template-2a.sh
similarity index 100%
rename from Sources/XToolDocs/Documentation.docc/First-app-code/template-2a.sh
rename to Documentation/xtool.docc/First-app-code/template-2a.sh
diff --git a/Sources/XToolDocs/Documentation.docc/First-app-code/template-2b.sh b/Documentation/xtool.docc/First-app-code/template-2b.sh
similarity index 100%
rename from Sources/XToolDocs/Documentation.docc/First-app-code/template-2b.sh
rename to Documentation/xtool.docc/First-app-code/template-2b.sh
diff --git a/Sources/XToolDocs/Documentation.docc/First-app-code/template-3a.sh b/Documentation/xtool.docc/First-app-code/template-3a.sh
similarity index 100%
rename from Sources/XToolDocs/Documentation.docc/First-app-code/template-3a.sh
rename to Documentation/xtool.docc/First-app-code/template-3a.sh
diff --git a/Sources/XToolDocs/Documentation.docc/First-app-code/template-3b.sh b/Documentation/xtool.docc/First-app-code/template-3b.sh
similarity index 100%
rename from Sources/XToolDocs/Documentation.docc/First-app-code/template-3b.sh
rename to Documentation/xtool.docc/First-app-code/template-3b.sh
diff --git a/Sources/XToolDocs/Documentation.docc/First-app-code/template-4a.sh b/Documentation/xtool.docc/First-app-code/template-4a.sh
similarity index 100%
rename from Sources/XToolDocs/Documentation.docc/First-app-code/template-4a.sh
rename to Documentation/xtool.docc/First-app-code/template-4a.sh
diff --git a/Sources/XToolDocs/Documentation.docc/First-app-code/template-4b.sh b/Documentation/xtool.docc/First-app-code/template-4b.sh
similarity index 100%
rename from Sources/XToolDocs/Documentation.docc/First-app-code/template-4b.sh
rename to Documentation/xtool.docc/First-app-code/template-4b.sh
diff --git a/Sources/XToolDocs/Documentation.docc/First-app.tutorial b/Documentation/xtool.docc/First-app.tutorial
similarity index 100%
rename from Sources/XToolDocs/Documentation.docc/First-app.tutorial
rename to Documentation/xtool.docc/First-app.tutorial
diff --git a/Sources/XToolDocs/Documentation.docc/Installation-Linux.md b/Documentation/xtool.docc/Installation-Linux.md
similarity index 100%
rename from Sources/XToolDocs/Documentation.docc/Installation-Linux.md
rename to Documentation/xtool.docc/Installation-Linux.md
diff --git a/Sources/XToolDocs/Documentation.docc/Installation-macOS.md b/Documentation/xtool.docc/Installation-macOS.md
similarity index 100%
rename from Sources/XToolDocs/Documentation.docc/Installation-macOS.md
rename to Documentation/xtool.docc/Installation-macOS.md
diff --git a/Sources/XToolDocs/Documentation.docc/Resources/Autocomplete.png b/Documentation/xtool.docc/Resources/Autocomplete.png
similarity index 100%
rename from Sources/XToolDocs/Documentation.docc/Resources/Autocomplete.png
rename to Documentation/xtool.docc/Resources/Autocomplete.png
diff --git a/Sources/XToolDocs/Documentation.docc/Resources/Cover.png b/Documentation/xtool.docc/Resources/Cover.png
similarity index 100%
rename from Sources/XToolDocs/Documentation.docc/Resources/Cover.png
rename to Documentation/xtool.docc/Resources/Cover.png
diff --git a/Sources/XToolDocs/Documentation.docc/Resources/Developer.PNG b/Documentation/xtool.docc/Resources/Developer.PNG
similarity index 100%
rename from Sources/XToolDocs/Documentation.docc/Resources/Developer.PNG
rename to Documentation/xtool.docc/Resources/Developer.PNG
diff --git a/Sources/XToolDocs/Documentation.docc/Resources/HelloWorld-Purple.png b/Documentation/xtool.docc/Resources/HelloWorld-Purple.png
similarity index 100%
rename from Sources/XToolDocs/Documentation.docc/Resources/HelloWorld-Purple.png
rename to Documentation/xtool.docc/Resources/HelloWorld-Purple.png
diff --git a/Sources/XToolDocs/Documentation.docc/Resources/HelloWorld.png b/Documentation/xtool.docc/Resources/HelloWorld.png
similarity index 100%
rename from Sources/XToolDocs/Documentation.docc/Resources/HelloWorld.png
rename to Documentation/xtool.docc/Resources/HelloWorld.png
diff --git a/Sources/XToolDocs/Documentation.docc/Resources/Home.png b/Documentation/xtool.docc/Resources/Home.png
similarity index 100%
rename from Sources/XToolDocs/Documentation.docc/Resources/Home.png
rename to Documentation/xtool.docc/Resources/Home.png
diff --git a/Sources/XToolDocs/Documentation.docc/Resources/Hover.png b/Documentation/xtool.docc/Resources/Hover.png
similarity index 100%
rename from Sources/XToolDocs/Documentation.docc/Resources/Hover.png
rename to Documentation/xtool.docc/Resources/Hover.png
diff --git a/Sources/XToolDocs/Documentation.docc/Resources/Hover2.png b/Documentation/xtool.docc/Resources/Hover2.png
similarity index 100%
rename from Sources/XToolDocs/Documentation.docc/Resources/Hover2.png
rename to Documentation/xtool.docc/Resources/Hover2.png
diff --git a/Sources/XToolDocs/Documentation.docc/Resources/SwiftExtension.png b/Documentation/xtool.docc/Resources/SwiftExtension.png
similarity index 100%
rename from Sources/XToolDocs/Documentation.docc/Resources/SwiftExtension.png
rename to Documentation/xtool.docc/Resources/SwiftExtension.png
diff --git a/Sources/XToolDocs/Documentation.docc/Resources/Trust.png b/Documentation/xtool.docc/Resources/Trust.png
similarity index 100%
rename from Sources/XToolDocs/Documentation.docc/Resources/Trust.png
rename to Documentation/xtool.docc/Resources/Trust.png
diff --git a/Sources/XToolDocs/Documentation.docc/Resources/UntrustedDev.png b/Documentation/xtool.docc/Resources/UntrustedDev.png
similarity index 100%
rename from Sources/XToolDocs/Documentation.docc/Resources/UntrustedDev.png
rename to Documentation/xtool.docc/Resources/UntrustedDev.png
diff --git a/Sources/XToolDocs/Documentation.docc/Resources/Verified.png b/Documentation/xtool.docc/Resources/Verified.png
similarity index 100%
rename from Sources/XToolDocs/Documentation.docc/Resources/Verified.png
rename to Documentation/xtool.docc/Resources/Verified.png
diff --git a/Sources/XToolDocs/Documentation.docc/footer.html b/Documentation/xtool.docc/footer.html
similarity index 92%
rename from Sources/XToolDocs/Documentation.docc/footer.html
rename to Documentation/xtool.docc/footer.html
index 329a283..cbfe10e 100644
--- a/Sources/XToolDocs/Documentation.docc/footer.html
+++ b/Documentation/xtool.docc/footer.html
@@ -2,7 +2,7 @@
footer {
display: flex;
justify-content: center;
- padding: 0.5rem 0;
+ padding: 0.5rem 0.8rem;
background-color: var(--color-fill-secondary);
text-align: center;
}
diff --git a/Sources/XToolDocs/Documentation.docc/Documentation.md b/Documentation/xtool.docc/xtool.md
similarity index 93%
rename from Sources/XToolDocs/Documentation.docc/Documentation.md
rename to Documentation/xtool.docc/xtool.md
index dd3c15f..2c58d8a 100644
--- a/Sources/XToolDocs/Documentation.docc/Documentation.md
+++ b/Documentation/xtool.docc/xtool.md
@@ -1,7 +1,7 @@
-# ``XToolDocs``
+# xtool
@Metadata {
- @DisplayName("xtool")
+ @TechnologyRoot
}
Cross-platform Xcode replacement.
diff --git a/Sources/XToolDocs/Documentation.docc/ToC.tutorial b/Documentation/xtool.docc/xtool.tutorial
similarity index 100%
rename from Sources/XToolDocs/Documentation.docc/ToC.tutorial
rename to Documentation/xtool.docc/xtool.tutorial
diff --git a/Netlify/build.sh b/Netlify/build.sh
deleted file mode 100755
index 50a9d34..0000000
--- a/Netlify/build.sh
+++ /dev/null
@@ -1,12 +0,0 @@
-#!/bin/bash
-
-set -euo pipefail
-
-cd "$(dirname "$0")"
-
-rm -rf docs
-
-swift package --allow-writing-to-package-directory \
- generate-documentation --target XToolDocs --disable-indexing \
- --experimental-enable-custom-templates \
- --output-path docs
diff --git a/Package.swift b/Package.swift
index b83ca5e..8237c1a 100644
--- a/Package.swift
+++ b/Package.swift
@@ -161,8 +161,5 @@ let package = Package(
],
cSettings: cSettings
),
- .executableTarget(
- name: "XToolDocs"
- ),
]
)
diff --git a/Sources/XToolDocs/main.swift b/Sources/XToolDocs/main.swift
deleted file mode 100644
index e69de29..0000000
diff --git a/netlify.toml b/netlify.toml
index 651f651..56dc869 100644
--- a/netlify.toml
+++ b/netlify.toml
@@ -2,36 +2,43 @@
# by setting a custom base directory, we prevent Netlify from running
# `swift build` in the root directory, which builds more targets than
# we need.
- base = "Netlify/"
+ base = "Documentation/"
publish = "docs/"
command = "./build.sh"
environment = { SWIFT_VERSION = "6.1" }
- ignore = "git -C .. diff --quiet $CACHED_COMMIT_REF $COMMIT_REF -- Sources/XToolDocs Netlify netlify.toml"
+ ignore = "git -C .. diff --quiet $CACHED_COMMIT_REF $COMMIT_REF -- Documentation netlify.toml"
[[redirects]]
from = "/"
- to = "/documentation/xtooldocs/"
+ to = "/documentation/xtool/"
status = 302
force = true
[[redirects]]
from = "/documentation"
- to = "/documentation/xtooldocs/"
+ to = "/documentation/xtool/"
status = 302
force = true
[[redirects]]
from = "/tutorials"
- to = "/tutorials/toc"
+ to = "/tutorials/xtool"
status = 302
force = true
+# --- Backwards compatibility ---
+
+[[redirects]]
+ from = "/tutorials/toc"
+ to = "/tutorials/xtool"
+ status = 302
+
[[redirects]]
- from = "/documentation/xtool/*"
- to = "/documentation/xtooldocs/:splat"
+ from = "/documentation/xtooldocs/*"
+ to = "/documentation/xtool/:splat"
status = 302
[[redirects]]
- from = "/tutorials/xtool/*"
- to = "/tutorials/xtooldocs/:splat"
+ from = "/tutorials/xtooldocs/*"
+ to = "/tutorials/xtool/:splat"
status = 302