docs: Add docs and web publishing

[redaranj]

Changes in this pull request

Adds inline docs to library files and provides a CI workflow to publish them to Github Pages.

Types of changes

• Bug fix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)
• Breaking change (fix or feature that would cause existing functionality to change)

Checklist

• All applicable changes have been documented
• Any TO DO items (or similar) have been entered as GitHub issues and the link to that issue has been included in a comment

[codecov]

Codecov Report

❌ Patch coverage is 30.00000% with 7 lines in your changes missing coverage. Please review.
✅ Project coverage is 52.07%. Comparing base (ea68831) to head (f06b7df).
⚠️ Report is 1 commits behind head on main.

Files with missing lines	Patch %	Lines
...ry/src/main/kotlin/org/contentauth/c2pa/Builder.kt	22.22%	7 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main       #8      +/-   ##
==========================================
- Coverage   53.65%   52.07%   -1.58%     
==========================================
  Files          13       13              
  Lines         863      797      -66     
  Branches      116      116              
==========================================
- Hits          463      415      -48     
+ Misses        327      309      -18     
  Partials       73       73              

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

[crandmck]

Same question as for ios, can we test/preview this before landing?

[crandmck]

At some point, we will probably want to change this to build/publish docs only on a release, rather than on push to main/docs branches. But at this stage, it should be fine.

[crandmck]

Does the content from this file get folded into the generated docs? I don't see it anywhere in https://contentauth.github.io/c2pa-android/c2pa-android/org.contentauth.c2pa/index.html and search doesn't return any hits either.

I would assume due to its location that it should be incorporated into the generated docs, but If it's actually meant for consumption in GitHub, then there are some minor formatting issues that should be fixed and it should be probably be moved to better location.

[redaranj]

The module name at the top of the file needed to be changed to exactly match the package. Now that that's done, the intro is showing on the site: https://contentauth.github.io/c2pa-android/

Happy to make any formatting changes.

[crandmck]

I'm going to merge this, but we need to remember to change this at some point to build/publish docs only on a release, rather than on push to main/docs branches.