Move to src/ layout (#382)

Author: tony

docs/conf.py

@@ -6,13 +6,14 @@
 # Get the project root dir, which is the parent dir of this
 cwd = Path.cwd()
 project_root = cwd.parent
+src_root = project_root / "src"
 
-sys.path.insert(0, str(project_root))
+sys.path.insert(0, str(src_root))
 sys.path.insert(0, str(cwd / "_ext"))
 
 # package data
 about = {}
-with open("../vcspull/__about__.py") as fp:
+with open(src_root / "vcspull" / "__about__.py") as fp:
     exec(fp.read(), about)
 
 extensions = [
@@ -221,16 +222,18 @@ def linkcode_resolve(domain, info):  # NOQA: C901
     fn = relpath(fn, start=dirname(vcspull.__file__))
 
     if "dev" in about["__version__"]:
-        return "{}/blob/master/{}/{}{}".format(
+        return "{}/blob/master/{}/{}/{}{}".format(
             about["__github__"],
+            "src",
             about["__package_name__"],
             fn,
             linespec,
         )
     else:
-        return "{}/blob/v{}/{}/{}{}".format(
+        return "{}/blob/v{}/{}/{}/{}{}".format(
             about["__github__"],
             about["__version__"],
+            "src",
             about["__package_name__"],
             fn,
             linespec,

pyproject.toml

@@ -19,7 +19,7 @@ classifiers = [
   "Topic :: System :: Shells",
 ]
 packages = [
-  { include = "vcspull" },
+  { include = "*", from = "src" },
 ]
 include = [
   { path = "tests", format = "sdist" },

setup.cfg

@@ -1,5 +1,5 @@
 [flake8]
-exclude = .*/,.tox,*.egg,vcspull/__*__.py,
+exclude = .*/,.tox,*.egg,src/vcspull/__*__.py,
 select = E,W,F,N
 max-line-length = 88
 # Stuff we ignore thanks to black: https://github.com/ambv/black/issues/429
@@ -19,6 +19,6 @@ line_length = 88
 [tool:pytest]
 addopts = --tb=short --no-header --showlocals
 testpaths =
-	vcspull
+	src/vcspull
 	tests
 	docs