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

Automatically generate documentation #1

Open
tbartelmess opened this issue May 16, 2020 · 0 comments
Open

Automatically generate documentation #1

tbartelmess opened this issue May 16, 2020 · 0 comments
Assignees
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@tbartelmess
Copy link
Owner

Currently, documentation needs to be generated manually by running

jazzy \                                          
  --module SwiftIcal \
  --swift-build-tool spm \
  --build-tool-arguments -Xswiftc,-swift-version,-Xswiftc,5

This should be moved into a GitHub action to avoid drift between the code and the generated documentation.

@tbartelmess tbartelmess added documentation Improvements or additions to documentation good first issue Good for newcomers labels May 16, 2020
@tbartelmess tbartelmess self-assigned this May 16, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

1 participant