swift-server/async-http-client
1
0
Fork 0
mirror of https://github.com/swift-server/async-http-client.git synced 2026-05-03 07:32:29 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add 'Show on GitHub' link to API docs (#17)

Browse Source 
Motivation:

Allowing readers of the API documentation to drill into the implementation of documented declarations can be educational and helpful for debugging, among several other reasons.

Modifications:

Add --github-file-prefix appending the current version in order to keep stable links. This means that documentation generated from any non-release revision may resolve incorrectly. This can be refined in the doc generation script later if it is deemed problematic by resolving to the commit sha if it doesn't exactly align with the version.

Result:

Users will be able to click a 'Show on GitHub' for all documented API declarations.
This commit is contained in:
tomer doron
2019-04-23 11:49:38 -07:00
committed by GitHub
parent 1d902e4cb3
commit 150216ea2b
1 changed files with 1 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
scripts/generate_docs.sh
+1
View File
@@ -57,6 +57,7 @@ jazzy_args=(--clean
--readme "$module_switcher"
--author_url https://github.com/swift-server/swift-nio-http-client
--github_url https://github.com/swift-server/swift-nio-http-client
--github-file-prefix https://github.com/swift-server/swift-nio-http-client/tree/$version
--theme fullwidth
--xcodebuild-arguments -scheme,swift-nio-http-client-Package)
cat > "$module_switcher" <<"EOF"