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

Remove docs from source #25

Open
jaredmoody opened this issue Mar 30, 2019 · 2 comments
Open

Remove docs from source #25

jaredmoody opened this issue Mar 30, 2019 · 2 comments

Comments

@jaredmoody
Copy link
Contributor

Because the docs are generated, I don't think they should be included in the source, at least not on the master branch.

Doing so adds a lot of noise to pull requests and makes merging/rebasing more difficult as well.

I saw you updated CONTRIBUTING.md to ask for docs to be generated with each PR - but think instead docs should only be generated with each gem release

@jaredmoody
Copy link
Contributor Author

This looks interesting:

https://github.com/trhodeos/yard-ghpages

You could include this gem, and then hook rake release to also run the yard:build and yard:publish tasks to automatically build and publish the docs whenever you release.

@KenjiOhtsuka
Copy link
Owner

@jaredmoody

It sounds good. I will try it.

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

2 participants