move file transfers from Makefile to py

Author: vpratz

docsrc/Makefile

@@ -4,7 +4,7 @@
 # You can set these variables from the command line, and also
 # from the environment for the first two.
 SPHINXOPTS    ?=
-SPHINXBUILD   ?= sphinx-multiversion
+SPHINXBUILD   ?= sphinx-build
 SOURCEDIR     = source
 BUILDDIR      = _build
 
@@ -18,26 +18,22 @@ help:
 # copy rendered docs and .nojekyll (for github.io) to docs folder
 # remove example notebooks from source folder
 github:
-# 	@cp ../INSTALL.rst source/installation.rst  # INSTALL.rst does not exist
-	@cp ../CONTRIBUTING.md source/contributing.md
+	@cp ../INSTALL.rst source/installation.rst
+	@cp ../CONTRIBUTING source/contributing.md
 	@cp -a ../examples/. source/_examples
-	@rm -rf source/_examples/in_progress  # ignore if in_progress does not exist
-	@$(SPHINXBUILD) "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS)
-	@echo 'Copying output from _build/html to ../docs.'
+	@rm -r source/_examples/in_progress
+	@make html
 	@cp -a _build/html/. ../docs
 	@cp .nojekyll ../docs/.nojekyll
+	@rm -r _build/html/
+	@rm -r source/_examples
+	@rm source/installation.rst
+	@rm source/contributing.md
 
 clean:
 	@rm -rf ../docs/*
 	@rm -rf _build
 
-clean-all:
-	@rm -rf ../docs/*
-	@rm -rf _build
-	@rm -rf source/_examples
-    # remove all files from source/api except for bayesflow.rst
-	@find source/api -type f ! -name 'bayesflow.rst' -exec rm -f {} +
-
 .PHONY: help Makefile
 
 # Catch-all target: route all unknown targets to Sphinx using the new

docsrc/poly.py

@@ -5,7 +5,7 @@
 from sphinx_polyversion.driver import DefaultDriver
 from sphinx_polyversion.git import Git, GitRef, GitRefType, file_predicate, refs_by_type
 from sphinx_polyversion.pyvenv import Pip
-from sphinx_polyversion.sphinx import CommandBuilder
+from sphinx_polyversion.sphinx import SphinxBuilder, Placeholder
 
 #: Regex matching the branches to build docs for
 BRANCH_REGEX = r"master-doctest"
@@ -73,7 +73,9 @@ def root_data(driver):
         buffer_size=1 * 10**9,  # 1 GB
         predicate=file_predicate([src]),  # exclude refs without source dir
     ),
-    builder=CommandBuilder(source=src / "source", cmd=["make", "github"]),
+    builder=SphinxBuilder(
+        src / "source", args=SPHINX_ARGS.split(), pre_cmd=["python", "pre-build.py", Placeholder.SOURCE_DIR]
+    ),
     env=Pip.factory(args=POETRY_ARGS.split(), venv="buildvenv"),
     template_dir=root / src / "polyversion/templates",
     static_dir=root / src / "polyversion/static",

docsrc/pre-build.py

@@ -0,0 +1,34 @@
+import os
+import shutil
+import sys
+from pathlib import Path
+
+
+def copy_files(sourcedir):
+    basedir = Path(sourcedir).parent.parent
+    print(basedir, sourcedir)
+
+    examples_src = os.path.join(basedir, "examples")
+    examples_dst = os.path.join(sourcedir, "_examples")
+    if os.path.exists(examples_src):
+        print("Copying examples")
+        shutil.copytree(examples_src, examples_dst, dirs_exist_ok=True)
+    examples_in_progress = os.path.join(examples_dst, "in_progress")
+    if os.path.exists(examples_in_progress):
+        shutil.rmtree(examples_in_progress)
+    contributing_src = os.path.join(basedir, "CONTRIBUTING.md")
+    contributing_dst = os.path.join(sourcedir, "contributing.md")
+    if os.path.exists(contributing_src):
+        shutil.copy2(contributing_src, contributing_dst)
+    installation_src = os.path.join(basedir, "INSTALL.rst")
+    installation_dst = os.path.join(sourcedir, "installation.rst")
+    if os.path.exists(installation_src):
+        shutil.copy2(installation_src, installation_dst)
+    print(os.listdir(sourcedir))
+    print(os.listdir(examples_dst))
+
+
+if __name__ == "__main__":
+    print("Running pre-build script")  # move files around if necessary
+    sourcedir = sys.argv[1]
+    copy_files(sourcedir)

docsrc/source/conf.py

@@ -11,7 +11,6 @@
 # documentation root, use os.path.abspath to make it absolute, like shown here.
 import os
 import sys
-import shutil
 from sphinx_polyversion import load
 from sphinx_polyversion.git import GitRef
 
@@ -134,49 +133,12 @@
 
 autosummmary_generate = True
 
-# sphinx-multiversion: select tags, branches and remotes
-smv_tag_whitelist = r"^(v1.1.6)$"
-# smv_branch_whitelist = r"^(|doc-autosummary|master|dev)$"
-smv_branch_whitelist = r"^(master)$"
-smv_remote_whitelist = None
-
-
-# move files around if necessary
-def copy_files_handler(app, config):
-    print("TODO")
-    return
-    current_version = config["smv_current_version"]
-    current_metadata = config["smv_metadata"][current_version]
-    basedir = current_metadata["basedir"]
-    sourcedir = current_metadata["sourcedir"]
-
-    print("Current version:", current_version)
-    print("Basedir:", basedir)
-    print("Metadata:", current_metadata)
-
-    examples_src = os.path.join(basedir, "examples")
-    examples_dst = os.path.join(sourcedir, "_examples")
-    if os.path.exists(examples_src):
-        shutil.copytree(examples_src, examples_dst, dirs_exist_ok=True)
-    examples_in_progress = os.path.join(examples_dst, "in_progress")
-    if os.path.exists(examples_in_progress):
-        shutil.rmtree(examples_in_progress)
-    contributing_src = os.path.join(basedir, "CONTRIBUTING.md")
-    contributing_dst = os.path.join(sourcedir, "contributing.md")
-    if os.path.exists(contributing_src):
-        shutil.copy2(contributing_src, contributing_dst)
-    installation_src = os.path.join(basedir, "INSTALL.rst")
-    installation_dst = os.path.join(sourcedir, "installation.rst")
-    if os.path.exists(installation_src):
-        shutil.copy2(installation_src, installation_dst)
-
 
 def cleanup_handler(app, exception):
     print("Done, what now?")
 
 
 def setup(app):
-    app.connect("config-inited", copy_files_handler)
     app.connect("build-finished", cleanup_handler)