Merge pull request #26 from Holzhaus/fix-non-repo-root-invocation

Fix failure to find refs when not called from repo root

docs/changelog.rst

@@ -14,6 +14,7 @@ Version 0.2.4 (unreleased)
 * Fix file existence check not working on Windows. (`#18 <issue18_>`_, `#19 <issue19_>`_)
 * Fix bug in the sphinx extension which tried to load the `conf.py` from the source directory instead of the conf directory. This could lead to problems when the two directories differ. (`#11 <issue11_>`_, `#13 <issue13_>`_)
 * Fix wrong import in :file:`__main__.py` that prevented invocation using ``python -m sphinx_multiversion``. (`#23 <issue23_>`_)
+* Fix failure to find refs if ``sphinx-multiversion`` was not invoked from the root of the git repository. (`#24 <issue24_>`_, `#25 <issue25_>`_)
 
 
 Version 0.2.3
@@ -66,3 +67,5 @@ Version 0.1.0
 .. _issue18: https://github.com/Holzhaus/sphinx-multiversion/issues/18
 .. _issue19: https://github.com/Holzhaus/sphinx-multiversion/issues/19
 .. _issue23: https://github.com/Holzhaus/sphinx-multiversion/issues/23
+.. _issue24: https://github.com/Holzhaus/sphinx-multiversion/issues/24
+.. _issue25: https://github.com/Holzhaus/sphinx-multiversion/issues/25

sphinx_multiversion/git.py

@@ -16,6 +16,16 @@ GitRef = collections.namedtuple(
 logger = logging.getLogger(__name__)
 
 
+def get_toplevel_path(cwd=None):
+    cmd = (
+        "git",
+        "rev-parse",
+        "--show-toplevel",
+    )
+    output = subprocess.check_output(cmd, cwd=cwd).decode()
+    return output.rstrip("\n")
+
+
 def get_all_refs(gitroot):
     cmd = (
         "git",
@@ -136,7 +146,7 @@ def file_exists(gitroot, refname, filename):
     return proc.returncode == 0
 
 
-def copy_tree(src, dst, reference, sourcepath="."):
+def copy_tree(gitroot, src, dst, reference, sourcepath="."):
     with tempfile.SpooledTemporaryFile() as fp:
         cmd = (
             "git",
@@ -147,7 +157,7 @@ def copy_tree(src, dst, reference, sourcepath="."):
             "--",
             sourcepath,
         )
-        subprocess.check_call(cmd, stdout=fp)
+        subprocess.check_call(cmd, cwd=gitroot, stdout=fp)
         fp.seek(0)
         with tarfile.TarFile(fileobj=fp) as tarfp:
             tarfp.extractall(dst)

sphinx_multiversion/main.py

@@ -63,6 +63,8 @@ def main(argv=None):
     if args.noconfig:
         return 1
 
+    logger = logging.getLogger(__name__)
+
     sourcedir_absolute = os.path.abspath(args.sourcedir)
     confdir_absolute = (
         os.path.abspath(args.confdir)
@@ -96,12 +98,19 @@ def main(argv=None):
     config.init_values()
 
     # Get relative paths to root of git repository
-    gitroot = pathlib.Path(".").resolve()
+    gitroot = pathlib.Path(
+        git.get_toplevel_path(cwd=sourcedir_absolute)
+    ).resolve()
+    logger.debug("Git toplevel path: %s", str(gitroot))
     sourcedir = os.path.relpath(sourcedir_absolute, str(gitroot))
+    logger.debug(
+        "Source dir (relative to git toplevel path): %s", str(sourcedir)
+    )
     if args.confdir:
         confdir = os.path.relpath(confdir_absolute, str(gitroot))
     else:
         confdir = sourcedir
+    logger.debug("Conf dir (relative to git toplevel path): %s", str(confdir))
     conffile = os.path.join(confdir, "conf.py")
 
     # Get git references
@@ -129,7 +138,7 @@ def main(argv=None):
             # Clone Git repo
             repopath = os.path.join(tmp, gitref.commit)
             try:
-                git.copy_tree(gitroot.as_uri(), repopath, gitref)
+                git.copy_tree(str(gitroot), gitroot.as_uri(), repopath, gitref)
             except (OSError, subprocess.CalledProcessError):
                 logger.error(
                     "Failed to copy git tree for %s to %s",