carekit-apple / CareKit

CareKit is an open source software framework for creating apps that help people better understand and manage their health.
https://www.researchandcare.org
Other
2.41k stars 443 forks source link

Add scripts for generating Swift-DocC documentation #705

Closed boisy closed 11 months ago

boisy commented 1 year ago

Summary

Adds scripts for generating, previewing, and publishing Swift-DocC documentation for CareKit.

Details

Testing

  1. Run Scripts/preview-documentation and confirm that the documentation site behaves as expected.
  2. Ethan Kusters deployed the documentation to the gh-pages branch on his fork which can be viewed here:

Notes

There will be a follow-up PR that adds a DocC catalog to the stable branch of CareKit and properly organizes the project's API.