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.

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

docs: use DocC for API documentation #350

Merged
merged 18 commits into from
Apr 12, 2022
Merged

docs: use DocC for API documentation #350

merged 18 commits into from
Apr 12, 2022

Conversation

cbaker6
Copy link
Contributor

@cbaker6 cbaker6 commented Mar 29, 2022

New Pull Request Checklist

Issue Description

DocC is now able to build static webpages for GitHub pages and can replace Jazzy.

Related issue: #n/a

Approach

Replace Jazzy with DocC for documentation.

TODOs before merging

  • Add entry to changelog
  • Add changes to documentation (guides, repository pages, in-code descriptions)

@parse-github-assistant
Copy link

parse-github-assistant bot commented Mar 29, 2022

Thanks for opening this pull request!

  • 🎉 We are excited about your hands-on contribution!

@codecov
Copy link

codecov bot commented Mar 29, 2022

Codecov Report

Merging #350 (57b181a) into main (eb755d2) will increase coverage by 0.68%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##             main     #350      +/-   ##
==========================================
+ Coverage   87.32%   88.00%   +0.68%     
==========================================
  Files         114      114              
  Lines       12209    12209              
==========================================
+ Hits        10661    10745      +84     
+ Misses       1548     1464      -84     
Impacted Files Coverage Δ
Sources/ParseSwift/Objects/ParseUser+async.swift 100.00% <ø> (ø)
Sources/ParseSwift/Objects/ParseUser+combine.swift 95.55% <ø> (ø)
Sources/ParseSwift/Objects/ParseUser.swift 86.12% <ø> (ø)
Sources/ParseSwift/Types/QueryConstraint.swift 97.92% <ø> (ø)
Sources/ParseSwift/Types/Query.swift 94.33% <0.00%> (+0.12%) ⬆️
Sources/ParseSwift/Objects/ParseObject.swift 85.03% <0.00%> (+0.15%) ⬆️
Sources/ParseSwift/Coding/ParseEncoder.swift 77.66% <0.00%> (+0.22%) ⬆️
Sources/ParseSwift/Storage/ParseFileManager.swift 92.57% <0.00%> (+0.57%) ⬆️
Sources/ParseSwift/API/API+Command.swift 89.21% <0.00%> (+0.82%) ⬆️
Sources/ParseSwift/Extensions/URLSession.swift 76.55% <0.00%> (+1.91%) ⬆️
... and 12 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update eb755d2...57b181a. Read the comment docs.

@cbaker6 cbaker6 closed this Apr 7, 2022
@cbaker6 cbaker6 reopened this Apr 7, 2022
@cbaker6 cbaker6 changed the title docs: improve docs with respect to parse-server 5.0.0 release docs: use DocC for API documentation Apr 12, 2022
@cbaker6 cbaker6 merged commit 1ad9ec2 into parse-community:main Apr 12, 2022
@cbaker6 cbaker6 deleted the docNits branch April 12, 2022 21:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant