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

How do I properly add newly generated docs to mruby.github.io? #45

Open
ghost opened this issue Aug 11, 2016 · 5 comments
Open

How do I properly add newly generated docs to mruby.github.io? #45

ghost opened this issue Aug 11, 2016 · 5 comments

Comments

@ghost
Copy link

ghost commented Aug 11, 2016

The last bit of documentation I wrote was approved of and merged by @matz into mruby. Now I want to add the documentation to mruby.org. Usually what would happen is that I'd generate the doc using mruby-yard. In this case, the only thing that changed was that I added docs to string.h. So I'd then take the generated doc in this case a file called mruby_2Fstring.h.html. Then I'd just copy and paste it to the proper directory in mruby.github.io then I'd do a PR. Of course, if it's merged it would then go live. Is that still okay? Because I remember before @zzak said that the size was too big. I want to make sure I do this correctly this time!

@zzak
Copy link
Contributor

zzak commented Aug 16, 2016

It looks like @sagmor wrote a script to do this, but I'm not sure.

@ghost
Copy link
Author

ghost commented Aug 23, 2016

@zzak That script generates the docs from the mruby repo. I'm not sure what to do next about the PR. I used the scipt ./gen/api then when I run git status I get a long list like this:

...
modified:   docs/api/String.html
modified:   docs/api/Struct.html
modified:   docs/api/Symbol.html
...

It still seems like it will make for a huge PR.

@zzak
Copy link
Contributor

zzak commented Aug 25, 2016

@Mav7 Right, yeah my guess is because they just haven't been generated in a while

@ghost
Copy link
Author

ghost commented Aug 25, 2016

@zzak So how would I go about doing PR then? It's still seems to be to much.

@zzak
Copy link
Contributor

zzak commented Aug 28, 2016

@Mav7 I mean, I think it's fine to send a PR to update the site -- but in the long run it's better to have this done automatically.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant