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 Jazzy docs #33

Closed
JoeMatt opened this issue Jul 23, 2020 · 1 comment · Fixed by #46
Closed

Add Jazzy docs #33

JoeMatt opened this issue Jul 23, 2020 · 1 comment · Fixed by #46
Labels
devops Adding or modifying DevOp services

Comments

@JoeMatt
Copy link
Collaborator

JoeMatt commented Jul 23, 2020

Overview

Jazzy is a tool for creating Apple doc style pages from source code comments and markdown files.

Requirements

  1. Add config file
  2. Add an action to auto create and publish new docs on merge to master
  3. Host as a GitHub page by publishing in /docs

Examples

Config

https://github.com/HeroTransitions/Hero/blob/develop/.github/workflows/rebase.yml

Actions sample

TODO
@JoeMatt JoeMatt added the devops Adding or modifying DevOp services label Jul 23, 2020
@JoeMatt JoeMatt linked a pull request Apr 16, 2021 that will close this issue
Release 1.2.1 #46
Merged
@JoeMatt
Copy link
Collaborator Author

JoeMatt commented Apr 16, 2021

closed by #46
https://rxswiftcommunity.github.io/RxReachability

@JoeMatt JoeMatt closed this as completed Apr 16, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
devops Adding or modifying DevOp services
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Release 1.2.1 RxSwiftCommunity/RxReachability
1 participant
@JoeMatt