ci: Add workflow to publish docs

parse-community / Parse-SDK-Flutter

The Dart/Flutter SDK for Parse Platform

https://parseplatform.org

Apache License 2.0

575 stars 186 forks source link

ci: Add workflow to publish docs #918

Closed mtrezza closed 1 year ago

mtrezza commented 1 year ago

Pull Request

Report security issues confidentially.
Any contribution is under this license.
Link this pull request to an issue.

Issue

API docs not published

Approach

Add workflow to publish docs to gh_pages

parse-github-assistant[bot] commented 1 year ago

I will reformat the title to use the proper commit message syntax.

parse-github-assistant[bot] commented 1 year ago

Thanks for opening this pull request!

❌ Please link an issue that describes the reason for this pull request, otherwise your pull request will be closed. Make sure to write it as Closes: #123 in the PR description, so I can recognize it.

codecov[bot] commented 1 year ago

Codecov Report

Patch and project coverage have no change.

Comparison is base (4f907c6) 38.51% compared to head (0b9e66f) 38.51%.

Additional details and impacted files

```diff @@ Coverage Diff @@ ## master #918 +/- ## ======================================= Coverage 38.51% 38.51% ======================================= Files 60 60 Lines 3331 3331 ======================================= Hits 1283 1283 Misses 2048 2048 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Do you have feedback about the report comment? Let us know in this issue.

mtrezza commented 1 year ago

I tried to generate both docs in 1 go so that both libs are in 1 output, but that didn't work by adding a dartdoc_options.yaml file with:

dartdoc:
  includeExternal: ['./packages/dart/lib/parse_server_sdk.dart']

No problem, we'll have two separate API documents for now.

mbfakourii commented 1 year ago

I tried to generate both docs in 1 go so that both libs are in 1 output, but that didn't work by adding a dartdoc_options.yaml file with:
dartdoc:
  includeExternal: ['./packages/dart/lib/parse_server_sdk.dart']
No problem, we'll have two separate API documents for now.

I think we should create a main page and link the two documents