-
Notifications
You must be signed in to change notification settings - Fork 69
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
Issues when conf.py invokes git #17
Comments
I don't think it's possible at the moment. Maybe it's feasible to make sphinx-multiversion set some environment variables with the actual git repository path and branch name when evaluating the config, and in your |
@Holzhaus Any reason why we couldn't just do a full tree copy in the |
I think for big repos this would be slow and very memory intensive (all repositories are checked out at once). It also could lead to all kinds of issues when the working tree is not clean. Originally I tried to use a local |
@Holzhaus Is it possible to have this as an option then? Would be happy to test and contribute too. |
Using the below change gets me past the issue highlighted here. It also does a shallow clone to be efficient. However, I have now run into another problem. We use a plugin (sphinx_substitution_extensions) that recently had a breaking change. So, I can either get old versions to work or new versions. Will have to figure out what to do here.
|
Hello. I've just faced with the same issue while building docs within docker container. There is a conf.py script which fetches list of tags and passes it to Read The Docs template. My suggestion is to provide additional script arguments for managing the way of making repo copies:
|
I'll try to come up with a PoC PR that will use git clone. By default it will use shallow clone, but that will be configurable. |
I think this should be solvable with |
Hmm, |
You can have multiple worktrees with the same commit / ref, but you do need to specify |
I mainly had CI workflows in mind where this usually isn't an issue. On a second thought it might be possible to combine the |
I have been trying to use sphinx-multiversion but I am running into what seems like a blocking issue because my conf.py calls git internally. Basically, similar to https://protips.readthedocs.io/git-tag-version.html, we use
git describe
to get the version of the docs we should be building.However, given what sphinx-multiversion does to copy a tree into
/tmp
, that fails as the tree copy isn't a real git repo and the conf.py git commands fail.Any suggestions on how to address this?
The text was updated successfully, but these errors were encountered: