54 ‐ About the documentation

We explained in the DEVELOP file and the release README how the documentation is managed.

In fact, the OUDS project contains mainly the iOS library exposed as a Swift Package, which contains several targets. The documentation based on doccarchives can be generated using the swift-docc-plugin and a custom script sending assets to GitHub Pages.

To run the script:

# Replace X.Y.Z by your versions numbers
./generateWebDocumentation.sh --libversion=X.Y.Z --usegit

Caution

Use of UIKit must be on-build-time conditioned. The possibility to merge all targets is still experimental. More details at #626.