Adds scripts for generating, previewing, and publishing Swift-DocC documentation for CareKit.
Details
Scripts/generate-documentation will generate a DocC archive containing the documentation for CareKit and emit the path of the archive.
Scripts/generate-documentation --preview will start a local web server to allow for previewing of the current CareKit documentation.
Scripts/update-gh-pages-documentation-site will build the documentation for CareKit and deploy it to the gh-pages branch on the remote.
The script checks the name of the branch it's being run from and automatically creates a separate documentation site per branch. So, moving forward, we'll be able to run the script from the main and stable branches in this repository and have up-to-date documentation for both at separate paths.
Testing
Run Scripts/preview-documentation and confirm that the documentation site behaves as expected.
I've deployed the documentation to the gh-pages branch on my fork which can be viewed here:
Summary
Adds scripts for generating, previewing, and publishing Swift-DocC documentation for CareKit.
Details
Scripts/generate-documentationwill generate a DocC archive containing the documentation for CareKit and emit the path of the archive.Scripts/generate-documentation --previewwill start a local web server to allow for previewing of the current CareKit documentation.Scripts/update-gh-pages-documentation-sitewill build the documentation for CareKit and deploy it to thegh-pagesbranch on the remote.mainandstablebranches in this repository and have up-to-date documentation for both at separate paths.Testing
Scripts/preview-documentationand confirm that the documentation site behaves as expected.gh-pagesbranch on my fork which can be viewed here:Notes
There will be a follow-up PR that adds a DocC catalog to the
stablebranch of CareKit and properly organizes the project's API.