docs: ✏️ build documentation with DocC and host on swiftpackageindex.com #613
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
MarcoEidinger
requested review from
billzhou0223 and
dyongxu
and removed request for
a team
billzhou0223
approved these changes
Nov 15, 2023
MarcoEidinger
added a commit
that referenced
this pull request
Nov 17, 2023
* 'main' of github.com:SAP/cloud-sdk-ios-fiori: fix: 🐛 [bcp: 0] remove background in ObjectHeader (#614) docs: ✏️ build documentation with DocC and host on swiftpackageindex.com (#613) chore: 🤖 refactor FioriIcon and support accessing cgImage through Image (#612) feat: 🎸 jira 2286 sort & filter for SwiftUI project (#606) fix: 🐛 [bcp: 2370136916] fix width mode for DimensionSelector (#610) feat: [JIRA: HCPSDKFIORIUIKIT-2444] Update to include more icons feat: [JIRA: HCPSDKFIORIUIKIT-2444] Update to include more icons chore: 🤖 update CI job for watchOS to use xcode 15 (#609) chore: 🤖 run CI job on macos-13 and xcode 15.0 (#608) feat: [JIRA: HCPSDKFIORIUIKIT-2444] Update to include more icons feat: [JIRA: HCPSDKFIORIUIKIT-2444] Update to include more icons feat: 🎸 [JIRA: HCPSDKFIORIUIKIT-2224] New FioriButtonStyle support (#603) feat: 🎸 [JIRA: HCPSDKFIORIUIKIT-2444] Update to include more icons feat: 🎸 [JIRA: HCPSDKFIORIUIKIT-2444] Update to include more icons feat: [JIRA: HCPSDKFIORIUIKIT-2444] Update to include more icons
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
FioriSwiftUI is currently accessible via the Swift Package Index (https://swiftpackageindex.com/SAP/cloud-sdk-ios-fiori).
This PR enhances our Swift Package Index experience by leveraging its auto-building and auto-hosting DocC feature to build and host the API Reference documentation for
FioriThemeManagerandFioriCharts.Motivation
Give the API reference a facelift using Apple's Swift Documentation Compiler (DocC).
DocC offers a similar feature set like
Jazzybut with a modern look, symbol search, platform availability indicators and theming options.Changes
.spi.ymlfileSee SPI docs on how this auto-hosted, auto-generated docs works. It's really neat! We could even have this replace our hosted reference docs entirely 👀.
.docc) and respective material for a better generation resultExpected results
Future changes
Suppose the result is as expected and satisfying. Any
Jazzyrelated information (e.g. overview pages, GitHub action to build Jazzy Doc and host as GitHub page, etc.) can be removed from the repository.