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

Issues building the documentation #135

Closed
gurbraj opened this issue Oct 10, 2018 · 2 comments
Closed

Issues building the documentation #135

gurbraj opened this issue Oct 10, 2018 · 2 comments
Labels
more info needed More information is required to action or process this issue or PR
Milestone
v4.6.0

Comments

@gurbraj
Copy link

gurbraj commented Oct 10, 2018

Hello,

When I run
$ bundle exec rake documentation
I get

bundle exec rake documentation        
rake aborted!
Don't know how to build task 'documentation' (see --tasks)

When I list my tasks using --tasks, documentation does not show up.

Any ideas?

When the local documentation is built, will it be the same as what is on https://www.rubydoc.info/github/auth0/ruby-auth0/Auth0Client? It seems quite incomplete...
jamietanna added a commit to jamietanna/ruby-auth0 that referenced this issue Oct 13, 2018
@jamietanna
Add missing redcarpet dependency
c345701 
While investigating auth0#135, I noticed that the build requires the
redcarpet gem, otherwise we get the error:

    [error]: Missing 'redcarpet' gem for Markdown formatting. Install it
    with `gem install redcarpet`
@jamietanna jamietanna mentioned this issue Oct 13, 2018
Closed
@joshcanhelp
Copy link
Contributor

joshcanhelp commented Oct 13, 2018 •
edited
Loading

Sorry for the trouble here and thank you for the report!

This is the up-to-date docs for the latest version:

https://www.rubydoc.info/gems/auth0/4.5.0/Auth0/Api/AuthenticationEndpoints

I'll investigate why the link you posted here is not up-to-date. It mentions master on there but I'm not seeing the latest auth endpoint docs added.

I'm seeing the task on my end and it runs without any issues (a few warning that need cleaning up). It creates an up-to-date version in the /docs folder for this gem. The task is initiated here. It might be a problem with how that task is structured so you can try one of the fixes here. If one of those work, let me know or create a PR and I'll test it out.

Also, can you try @jamietanna's fix above (#136) and see if that makes a difference?

Thank you!

@joshcanhelp
Copy link
Contributor

Closed for no activity

@joshcanhelp joshcanhelp added the more info needed More information is required to action or process this issue or PR label Nov 20, 2018
@joshcanhelp joshcanhelp added this to the v4.6.0 milestone Dec 17, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
more info needed More information is required to action or process this issue or PR
Projects
None yet
Milestone
v4.6.0
Development

No branches or pull requests
2 participants
@joshcanhelp @gurbraj