improve configuration

Author: vpratz

docsrc/poly.py

@@ -1,38 +1,43 @@
-from datetime import datetime
+from functools import partial
 from pathlib import Path
 
 from sphinx_polyversion.api import apply_overrides
 from sphinx_polyversion.driver import DefaultDriver
-from sphinx_polyversion.git import Git, GitRef, GitRefType, file_predicate, refs_by_type
+from sphinx_polyversion.git import Git, file_predicate, refs_by_type, closest_tag
 from sphinx_polyversion.pyvenv import Pip
 from sphinx_polyversion.sphinx import SphinxBuilder, Placeholder
 
-#: Regex matching the branches to build docs for
-BRANCH_REGEX = r"master-doctest"
+#: CodeRegex matching the branches to build docs for
+BRANCH_REGEX = r"(doc-polyversion)"
 
 #: Regex matching the tags to build docs for
-TAG_REGEX = r"v1.1.6"
+TAG_REGEX = r"v1.1.6.1"
 
 #: Output dir relative to project root
 OUTPUT_DIR = "_polybuild"
 
 #: Source directory
 SOURCE_DIR = "docsrc/"
 
-#: Arguments to pass to `pip install`
-POETRY_ARGS = "bayesflow"
-
 #: Arguments to pass to `sphinx-build`
 SPHINX_ARGS = "-a -v"
 
-#: Mock data used for building local version
-MOCK_DATA = {
-    "revisions": [
-        GitRef("v1.1.6", "", "", GitRefType.TAG, datetime.fromtimestamp(0)),
-        GitRef("master-doctest", "", "", GitRefType.BRANCH, datetime.fromtimestamp(3)),
-    ],
-    "current": GitRef("master-doctest", "", "", GitRefType.TAG, datetime.fromtimestamp(6)),
-}
+#: Extra packages for building docs
+SPHINX_DEPS = [
+    "sphinx",
+    "numpydoc",
+    "myst-nb",
+    "sphinx_design",
+    "sphinx-book-theme",
+    "sphinxcontrib-bibtex",
+    "sphinx-polyversion==1.0.0",
+]
+
+BACKEND_DEPS = [
+    "jax",
+    "torch",
+    "tensorflow",
+]
 
 
 #: Data passed to templates
@@ -60,7 +65,19 @@ def root_data(driver):
 apply_overrides(globals())
 # Determine repository root directory
 root = Git.root(Path(__file__).parent)
-print("root", root)
+
+
+async def selector(f, a, b):
+    return a.name
+
+
+# Setup environments for the different versions
+
+ENVIRONMENT = {
+    None: Pip.factory(venv=Path(".venv"), args=["-vv", "bayesflow==1.1.6"] + SPHINX_DEPS),
+    "doc-polyversion": Pip.factory(venv=Path(".venv/dev"), args=["-vv", "-e", "."] + SPHINX_DEPS + BACKEND_DEPS),
+    "v1.1.6": Pip.factory(venv=Path(".venv/v1.1.6"), args=["-vv", "bayesflow==1.1.6"] + SPHINX_DEPS),
+}
 
 # Setup driver and run it
 src = Path(SOURCE_DIR)
@@ -74,9 +91,12 @@ def root_data(driver):
         predicate=file_predicate([src]),  # exclude refs without source dir
     ),
     builder=SphinxBuilder(
-        src / "source", args=SPHINX_ARGS.split(), pre_cmd=["python", "pre-build.py", Placeholder.SOURCE_DIR]
+        src / "source",
+        args=SPHINX_ARGS.split(),
+        pre_cmd=["python", root / src / "pre-build.py", Placeholder.SOURCE_DIR],
     ),
-    env=Pip.factory(args=POETRY_ARGS.split(), venv="buildvenv"),
+    env=ENVIRONMENT,
+    selector=partial(selector, partial(closest_tag, root)),
     template_dir=root / src / "polyversion/templates",
     static_dir=root / src / "polyversion/static",
     data_factory=data,

docsrc/pre-build.py

@@ -2,12 +2,14 @@
 import shutil
 import sys
 from pathlib import Path
+from sphinx_polyversion.git import Git
 
 
 def copy_files(sourcedir):
     basedir = Path(sourcedir).parent.parent
     print(basedir, sourcedir)
 
+    # copy examples
     examples_src = os.path.join(basedir, "examples")
     examples_dst = os.path.join(sourcedir, "_examples")
     if os.path.exists(examples_src):
@@ -16,6 +18,7 @@ def copy_files(sourcedir):
     examples_in_progress = os.path.join(examples_dst, "in_progress")
     if os.path.exists(examples_in_progress):
         shutil.rmtree(examples_in_progress)
+    # copy contributing and installation
     contributing_src = os.path.join(basedir, "CONTRIBUTING.md")
     contributing_dst = os.path.join(sourcedir, "contributing.md")
     if os.path.exists(contributing_src):
@@ -24,11 +27,36 @@ def copy_files(sourcedir):
     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))
+    # create empty bibtex file if none exists
+    bibtex_path = os.path.join(sourcedir, "references.bib")
+    if not os.path.exists(bibtex_path):
+        open(bibtex_path, "a").close()
+
+
+def patch_conf(sourcedir):
+    root = Git.root(Path(__file__).parent)
+    cursrc = os.path.join(root, "docsrc", "source")
+    # copy the configuration file: shared for all versions
+    conf_src = os.path.join(cursrc, "conf.py")
+    conf_dst = os.path.join(sourcedir, "conf.py")
+    if os.path.exists(conf_src):
+        print("Overwriting old conf.py with current conf.py")
+        shutil.copy2(conf_src, conf_dst)
+    # copy HTML and CSS for versioning sidebar
+    versioning_src = os.path.join(cursrc, "_templates", "versioning.html")
+    versioning_dst = os.path.join(sourcedir, "_templates", "versioning.html")
+    if os.path.exists(versioning_src):
+        os.makedirs(os.path.join(sourcedir, "_templates"), exist_ok=True)
+        shutil.copy2(versioning_src, versioning_dst)
+    css_src = os.path.join(cursrc, "_static", "custom.css")
+    css_dst = os.path.join(sourcedir, "_static", "custom.css")
+    if os.path.exists(css_src):
+        os.makedirs(os.path.join(sourcedir, "_static"), exist_ok=True)
+        shutil.copy2(css_src, css_dst)
 
 
 if __name__ == "__main__":
     print("Running pre-build script")  # move files around if necessary
     sourcedir = sys.argv[1]
     copy_files(sourcedir)
+    patch_conf(sourcedir)

docsrc/source/_templates/versioning.html

@@ -4,15 +4,15 @@
   <p class="caption" aria-level="2" role="heading"><span class="caption-text">{{ _('Tags') }}</span></p>
   <ul>
     {%- for item in tags %}
-      <li><a href="../{{ item.name }}/index.html" {% if current and current.name == item.name %}class="current"{% endif %}>{{ item.name }}</a></li>
+      <li><a href="/{{ item.name }}/index.html" {% if current and current.name == item.name %}class="current"{% endif %}>{{ item.name }}</a></li>
     {%- endfor %}
   </ul>
   {% endif %}
   {% if branches %} {# List of branches #}
   <p class="caption" aria-level="2" role="heading"><span class="caption-text">{{ _('Branches') }}</span></p>
   <ul>
     {%- for item in branches %}
-      <li><a href="../{{ item.name }}/index.html" {% if current and current.name == item.name %}class="current"{% endif %}>{{ item.name }}</a></li>
+      <li><a href="/{{ item.name }}/index.html" {% if current and current.name == item.name %}class="current"{% endif %}>{{ item.name }}</a></li>
     {%- endfor %}
   </ul>
   {% endif %}

docsrc/source/conf.py

@@ -133,14 +133,6 @@
 
 autosummmary_generate = True
 
-
-def cleanup_handler(app, exception):
-    print("Done, what now?")
-
-
-def setup(app):
-    app.connect("build-finished", cleanup_handler)
-
-
+# versioning data for template
 data = load(globals())
 current: GitRef = data["current"]