-
Notifications
You must be signed in to change notification settings - Fork 305
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add generated docs for sdc-0.1.0-beta03, engine-0.1.0-beta01, workflow-0.1.0-alpha01 #1467
Conversation
Codecov Report
@@ Coverage Diff @@
## master #1467 +/- ##
=============================================
+ Coverage 0 89.74% +89.74%
- Complexity 0 646 +646
=============================================
Files 0 129 +129
Lines 0 9879 +9879
Branches 0 742 +742
=============================================
+ Hits 0 8866 +8866
- Misses 0 622 +622
- Partials 0 391 +391
|
Can you please document the gradle task to run to generate the docs? |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
why are some of the file names and directory names include so many hypens "-"?
Catching back up after vacation.
|
When do they need to be run? Each time we make a release? In that case should be documented in our release process.
ah ok if this is just a dokka thing and we can't control it's fine. |
how can we preview this docs? |
Correct - I will update the release documentation with instructions after #1466 is merged. I'll also need to regenerate the data capture docs to reflect the values in Releases.kt ( |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks like /docs/engine/html/engine
is a duplicate of /docs/engine/engine
?
sdc
and workflow
don't have the html/
subdiretory.
Fixed, I must have messed up copying docs around to generate at 3 different tags. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
thanks for this
IMPORTANT: All PRs must be linked to an issue (except for extremely trivial and straightforward changes).
Fixes #1457
Description
Generated reference docs for each library's latest released version by doing e.g.
git checkout tags/sdc-0.1.0-beta03 -b sdc-0.1.0-beta03
and running a gradle task similar to PR #1466 .Alternative(s) considered
Placing docs into a version-named directory
Type
Documentation
Checklist
./gradlew spotlessApply
and./gradlew spotlessCheck
to check my code follows the style guide of this project../gradlew check
and./gradlew connectedCheck
to test my changes locally.