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

gh-deploy assumes docs dir is located in repository root #578

Closed
gitblit opened this issue Jun 1, 2015 · 3 comments
Closed

gh-deploy assumes docs dir is located in repository root #578

gitblit opened this issue Jun 1, 2015 · 3 comments
Labels
Milestone

Comments

@gitblit
Copy link

gitblit commented Jun 1, 2015

gh-deploy is assuming the docs directory is located in the root of the repository. In my case, I've located my project/site sources in a subdirectory (e.g. /site/docs) and the following check causes gh-deploy to immediately terminate:

https://github.com/mkdocs/mkdocs/blob/master/mkdocs/gh_deploy.py#L10

I'm not sure if there are other downstream failures from this initial termination, but it would be nice to be able to use gh-deploy in this scenario.

@waylan
Copy link
Member

waylan commented Jun 1, 2015

Is this the same as #543? If so, I suppose this could be better documented.

@d0ugal
Copy link
Member

d0ugal commented Jun 1, 2015

Somewhat related, but this is worse 😄 If I had the following layout

/project/
/project/.git <- this is the repo
/docs/
/docs/mkdocs.yml
/docs/source/ <- the markdown files

You would need to be in the directory above the mkdocs.yml for gh-deploy to be happy. So, we should use this:

git rev-parse --is-inside-work-tree

@d0ugal d0ugal added the Bug label Jun 1, 2015
@gitblit
Copy link
Author

gitblit commented Jun 1, 2015

👍 That would be super.

@d0ugal d0ugal modified the milestones: 0.14.0, 0.15.0 Jun 2, 2015
@d0ugal d0ugal closed this as completed in b73027f Jun 6, 2015
@d0ugal d0ugal reopened this Jun 6, 2015
@d0ugal d0ugal closed this as completed in ca5d6f9 Jun 7, 2015
@d0ugal d0ugal modified the milestones: 0.14.0, 0.15.0 Jun 7, 2015
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

3 participants