Skip to content
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.

Sign up for GitHub

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

Jump to bottom

add documentation page #131

Merged
merged 3 commits into from Jul 12, 2021
Merged

add documentation page #131

merged 3 commits into from Jul 12, 2021

Conversation

johnnychen94
Copy link
Member

Three pages are added:

  • index page: package overview and a simple explanation on the warp internal
  • function reference page: organized in three parts: high-level, low-level API, and utilities.
  • demo page: currently only add swirl example to illustrate how to use custom warp map (address Can warp also be used as a remap like in opencv? #64)

Irrelevant change to unit test CI:

  • only test Julia:1 on windows and macos platform because of the limited CI resource
  • remove cron job because GHA would otherwise disable the CI after 30(or 60) days inactivity.

@johnnychen94
reduce CI workload
f8301d6 
remove scheduled CI because otherwise Github Action will disable the
whole CI if the repo is not active for 60 days.

only test windows-latest and macos-latest for Julia 1.x release to
save our limited CI resources
@johnnychen94
setup docs and docs CI
506ddd7
@johnnychen94 johnnychen94 force-pushed the jc/docs branch 2 times, most recently from dc9b5f8 to 808f1e0 Compare July 12, 2021 13:20
@johnnychen94
Copy link
Member Author

There seems a breaking Interpolations version introduced; I'll try to fix it in a new PR.

@johnnychen94 johnnychen94 merged commit 5cc52e8 into master Jul 12, 2021
@johnnychen94 johnnychen94 deleted the jc/docs branch July 12, 2021 13:33
@johnnychen94 johnnychen94 mentioned this pull request Jul 13, 2021
Merged
13 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
1 participant
@johnnychen94