Skip to content

Build docs for GitHub forks/branches (or pull requests) #239

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

Closed
jodal opened this issue Sep 5, 2012 · 4 comments
Closed

Build docs for GitHub forks/branches (or pull requests) #239

jodal opened this issue Sep 5, 2012 · 4 comments
Labels
Improvement Minor improvement to code

Comments

@jodal
Copy link
Member

jodal commented Sep 5, 2012

Annotating commits on GitHub with the build status (see #238) would become a lot more useful if ReadTheDocs also built docs for forks and branches. Then pull requests would be able to say if changes to docs will build OK.

Another way to achieve this would be to build docs for any pull request to the main repo, ignoring forks and branches that never leads to pull requests.

@wraithan
Copy link
Contributor

wraithan commented Sep 7, 2012

Adding support for forks is rather expensive and they'd have to have their post-receive hook setup and working as well. If I recall correctly forks do not inherit these.

Pull requests is more possible, but currently we don't have a way of dealing with any type of hook except for the post-receive. Also these forks/etc would be listed in the versions and such and I don't know if that is desirable (very easy to do malicious or at least troll-y things.)

@adamcik
Copy link

adamcik commented Sep 7, 2012

The way I imagined this would work when discussing this with @jodal was that there would simply be build for the sake of doing a lint / error check, as most likely there are few use cases for publishing random un-merged docs. While being notified that merging this pull request / branch / ... would break the docs / introduced an error up front would be awesome :-)

@wraithan
Copy link
Contributor

I am conflicted on this. For linting purposes, it feels like something one should setup with their travis-ci stuff. But their environment is not the same as readthedocs so it wont give you a 100% accurate results.

For now I am -0 on building for purely linting/error checking purposes, would love to hear what you think @ericholscher

@wraithan
Copy link
Contributor

Closing this, I've discussed it a few times and it is outside of the scope of Read the Docs.

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

No branches or pull requests

3 participants