-
Notifications
You must be signed in to change notification settings - Fork 75
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[SDK-3450] API Documentation Generation #144
Merged
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
evansims
added
documentation
This adds, fixes or improves documentation
review:tiny
Tiny review
labels
Jun 21, 2022
evansims
commented
Jun 21, 2022
# Generate the .doccarchive | ||
sh "xcodebuild docbuild -scheme SimpleKeychain-iOS -configuration Release -destination 'generic/platform=iOS' -derivedDataPath docs.archive" | ||
# Generate the static site | ||
sh "$(xcrun --find docc) process-archive transform-for-static-hosting docs.archive/Build/Products/Release-iphoneos/SimpleKeychain.doccarchive --hosting-base-path SimpleKeychain --output-path docs" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
You were right about --hosting-base-path
being necessary — my bad! 👍 I've already made the change over on JWTDecode.swift to reflect this as well.
5 tasks
Widcket
approved these changes
Jun 22, 2022
Widcket
added a commit
that referenced
this pull request
Jul 20, 2022
* Add migration guide [SDK-3393] (#127) Add migration guide * Remove license header from source files [SDK-3389] (#126) Remove license header * Update year in license file (#128) * Add `.swiftpm` directory to `.gitignore` (#131) Add `.swiftpm` to `.gitignore` * Add CONTRIBUTING.md (#130) * Drop old platform versions [SDK-3387] (#129) * Drop old platform versions * Remove preprocessor macros and compatibility code * Remove obsolete preprocessor macros * Use accesibility config when neither iOS nor macOS * Remove unnecessary preprocessor macros * Remove extra blank line at the end of the file * Restore Touch ID case * Remove leftover nested if * Update README [SDK-3416] (#135) * Remove deprecated method [SDK-3413] (#132) * Remove deprecated method * Add change to the migration guide * Remove usage of deprecated properties [SDK-3414] (#133) * Remove usage of deprecated APIs * Remove enum cases * Remove usage of enum cases * Update V1_MIGRATION_GUIDE.md Co-authored-by: Steve Hobbs <steve.hobbs@auth0.com> Co-authored-by: Steve Hobbs <steve.hobbs@auth0.com> * Add support policy [SDK-3420] (#138) * Fix typo in property name (#137) * Remove obsolete functionality [SDK-3419] (#136) * [SDK-3434] Update issues templates (#140) * [SDK-3434] Migrate GitHub issue templates * Update config.yml * Update config.yml * Add note about the Responsible Disclosure Program to bug reports template. * Remove "FAQ.md" reference, as there is no file * Update .github/ISSUE_TEMPLATE/Bug Report.yml * Update .github/ISSUE_TEMPLATE/Feature Request.yml * Update .github/ISSUE_TEMPLATE/Bug Report.yml * Update .github/ISSUE_TEMPLATE/Feature Request.yml * Update .github/ISSUE_TEMPLATE/config.yml * Update .github/ISSUE_TEMPLATE/config.yml * Update checkbox grouping * Update Pull Request template Co-authored-by: Rita Zerrizuela <zeta@widcket.com> * Migrate to Swift [SDK-3428] (#139) * Migrate to Swift * Add test case * Integrate SwiftLint * Add .swiftlint.yml * Fix tests * Add API docs * Update migration guide * Remove leftover comments * Update library description * Add snippets to the API docs * Drop Xcode 12.x and its older simulators * Add item to the migration guide * Drop support for old Swift versions [SDK-3444] (#141) * Add missing unit tests (#142) * Add missing tests * Remove extra whitespace * Add missing import for SPM * Apply recommended Xcode 14 settings (#143) * [SDK-3450] API Documentation Generation (#144) * Add generated API documentation to repo (#145) * Add support for iCloud synchronization (#146) * Add support for iCould synchronization * Update API docs * Add unit tests for queries (#147) Test queries * Improve API docs generation (#148) * Fix typos in tests (#149) * Make `context` parameter optional (#151) * Re-generate API docs (#152) * Complete README and Migration Guide [SDK-3397] (#150) * Add support for custom attributes (#153) * Replace OSX with macOS in schemes and targets (#154) Replace OSX with macOS * Release 1.0.0-fa.0 (#155) * Add fa to Podspec version (#156) * Fix 'access group' capitalization (#158) * Update API docs (#159) * Use Codecov orb (#161) * Create .semgrepignore * Add placeholders to issue forms (#162) * Update README for GA [SDK-3500] (#163) Update the README for GA * Merge `master` into `fa` (#164) Co-authored-by: Steve Hobbs <steve.hobbs@auth0.com> Co-authored-by: Evan Sims <evan.sims@auth0.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Labels
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Changes
This PR adds API documentation generation using DocC. The documentation itself will be committed as a seperate PR, for reviewability sake.
References
See internal ticket SDK-3450
Testing
Please describe how this can be tested by reviewers. Be specific about anything not tested and reasons why. If helpful, please include manual testing steps as well.
Checklist