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

Generating docs #16

Open
odimitrov opened this issue Feb 6, 2019 · 0 comments
Open

Generating docs #16

odimitrov opened this issue Feb 6, 2019 · 0 comments

Comments

@odimitrov
Copy link
Contributor

For generating documentation we use Jazzy.

Installation

[sudo] gem install jazzy

Usage

On root execute the following command
jazzy --clean -a InPlayer -u https://inplayer.com/ --module InPlayerSDK --github_url https://github.com/inplayer-org/inplayer-ios-sdk --min-acl public

You can check the additional parameters jazzy -h
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@odimitrov