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

Setup Documentation with DocC #11

Closed
3 tasks done
r3to opened this issue Mar 25, 2024 · 3 comments · Fixed by #13
Closed
3 tasks done

Setup Documentation with DocC #11

r3to opened this issue Mar 25, 2024 · 3 comments · Fixed by #13
Assignees
@r3to

Comments

@r3to
Copy link
Contributor

r3to commented Mar 25, 2024 •
edited
Loading

Use DocC for developer friendly documentation of the Swift Package

Tasks:

  • Basic setup for DocC and building of the Documentation
  • Publish on Github Pages using publishing using GitHub Actions
  • Make an introduction page
@r3to r3to converted this from a draft issue Mar 25, 2024
@r3to
Copy link
Contributor Author

r3to commented Mar 25, 2024 •
edited
Loading

Notes: can't use Swift-DocC-Plugin as it only seams to support documentation for MacOS targets

@r3to r3to self-assigned this Mar 26, 2024
@r3to
Copy link
Contributor Author

r3to commented Mar 26, 2024

See https://github.com/x-0o0/package-docc-example/blob/main/README_ENG.md#set-deployment-condition-to-github-actions for an example on how to setup deployment

@r3to
Copy link
Contributor Author

r3to commented Apr 3, 2024

related MR: #13

@r3to r3to linked a pull request Apr 3, 2024 that will close this issue
setup DocC #13
Merged
@terencebls terencebls moved this from In progress to Done in OJP 2.0 SDKs Apr 11, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@r3to r3to

Labels
None yet
Projects
OJP 2.0 SDKs
Status: Done
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

setup DocC openTdataCH/ojp-ios
2 participants
@r3to @terencebls