Working with git submodules

I’m attempting to switch to sphinx-multiversion, but I’ve run into an issue that I don’t think there is an existing solution for. If there isn’t, I’m curious if this is something you’d be willing to support and how you’d like it implemented.

I have a project where the code is in one repository and the sphinx docs source files are in another. The docs repository is included in the code repository as a git submodule. So you have something like:

myrepos/
    mypkg/
        __init__.py
    doc/  <-- git submodule
        conf.py

I’d like sphinx-multiversion to take the tags and branches it uses from the code repository (myrepos/), but because doc/ is also a git repository itself sphinx-multiversion is only using the ones defined there. Is it possible to make sphinx-multiversion look one level up for the main repository?

[taironemagalhaes]

I also ran into another issue that is probably related to the git archive strategy. In my project I’m using the extension matplotlib.sphinxext.plot_directive to generate plots dynamically. The images generated using this extension are pointing to the build directory in the final html (e.g. /var/folders/0x/lypfmsxn567blxmckglkdk7w0000gn/T/tmpnnbp7yj1/95cac2b19a3156da5a6d46f657da237d0ad4f54d/docs), so when I deploy my docs to github pages the images are not found. I wasn’t able to find any workaround to deal with this issue.

For now I guess I will deploy only the docs generated for the latest version of my project, but in the future I plan to dive further into this issue.

[Holzhaus]

@taironemagalhaes That sounds like a bug in the extension you’re using. It should generate the images in the output directory, not the source directory. Or it should use relative paths and copy the generated images to the output dir.