sphinxext-bsb 0.2.5__py3-none-any.whl → 5.0.0__py3-none-any.whl

sphinxext/bsb/project.py

@@ -0,0 +1,108 @@
+import importlib.metadata
+import json
+import os
+from pathlib import Path
+
+
+class Project:
+    def __init__(self, project_name: str, project_folder: Path, monorepo=False):
+        self._project_name = project_name
+        self._root_folder = project_folder
+        self._local_only = os.getenv("BSB_LOCAL_INTERSPHINX_ONLY", "false") == "true"
+        self._monorepo = monorepo
+
+    @property
+    def name(self):
+        return self._project_name
+
+    @property
+    def monorepo(self):
+        return self._monorepo
+
+    @property
+    def copyright(self):
+        return "2021-%Y, DBBS University of Pavia"
+
+    @property
+    def authors(self):
+        return "Robin De Schepper, Dimitri Rodarie, Filippo Marchetti"
+
+    @property
+    def package_name(self):
+        return self._root_folder.stem
+
+    @property
+    def version(self):
+        return importlib.metadata.version(self.package_name)
+
+    @property
+    def extensions(self):
+        return ["sphinxext.bsb"]
+
+    @property
+    def intersphinx(self):
+        if self._monorepo:
+            return {
+                _get_mapped_name(pkg): self.interbsb(pkg)
+                for pkg in self._get_monorepo_doc_dependencies()
+            }
+        return {}
+
+    @property
+    def _doc_path(self):
+        if self._monorepo:
+            return self._root_folder / "../../packages/bsb/docs"
+        else:
+            return self._root_folder / "docs"
+
+    @property
+    def html_static_path(self):
+        return [str(self._doc_path / "_static")]
+
+    @property
+    def html_favicon(self):
+        return str(self._doc_path / "_static/bsb_ico.svg")
+
+    @property
+    def html_theme_options(self):
+        return {
+            "light_logo": "bsb.svg",
+            "dark_logo": "bsb_dark.svg",
+            "sidebar_hide_name": True,
+        }
+
+    @property
+    def html_context(self):
+        return {
+            "maintainer": self.authors,
+            "project_pretty_name": self.name,
+            "projects": {"bsb": "https://github.com/dbbs/bsb"},
+        }
+
+    def interbsb(self, dep_package):
+        local_folder = (
+            self._root_folder / f"../../packages/{dep_package}/docs/_build/iso-html"
+        )
+        remote = f"https://{dep_package}.readthedocs.io/en/latest"
+
+        if self._local_only:
+            return remote, str(local_folder / "objects.inv")
+        else:
+            return remote, (None, str(local_folder / "objects.inv"))
+
+    def _get_monorepo_project(self):
+        return json.loads((self._root_folder / "project.json").read_text())
+
+    def _get_monorepo_doc_dependencies(self):
+        project = self._get_monorepo_project()
+        doc_dependencies: list[str] = (
+            project.get("targets", {}).get("docs", {}).get("dependsOn", [])
+        )
+        return [k.split(":")[0] for k in doc_dependencies if k.endswith(":iso-docs")]
+
+
+def _get_mapped_name(bsb_pkg):
+    if bsb_pkg == "bsb-core":
+        return "bsb"
+    else:
+        return bsb_pkg.replace("-", "_")

sphinxext_bsb-5.0.0.dist-info/METADATA

@@ -0,0 +1,18 @@
+Metadata-Version: 2.4
+Name: sphinxext-bsb
+Version: 5.0.0
+Summary: BSB Sphinx documentation extension
+Requires-Python: >=3.10,<4
+Description-Content-Type: text/markdown
+Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
+License-File: LICENSE
+Requires-Dist: bsb-core~=6.0
+Requires-Dist: sphinx>=8.1
+Requires-Dist: sphinx-design~=0.6
+
+[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
+
+# sphinxext-bsb
+
+Sphinx extension for the BSB documentation.
+

sphinxext_bsb-5.0.0.dist-info/RECORD

@@ -0,0 +1,6 @@
+sphinxext/bsb/__init__.py,sha256=ffT_qS3a1KoFpabtqX0T-L1q4tI95tKP2NAcz54ND1o,13050
+sphinxext/bsb/project.py,sha256=-uwzHOt6mSRH7sG-jYBuUXtSzYW3qxk7aCdhOzRp8BE,2970
+sphinxext_bsb-5.0.0.dist-info/licenses/LICENSE,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
+sphinxext_bsb-5.0.0.dist-info/WHEEL,sha256=G2gURzTEtmeR8nrdXUJfNiB3VYVxigPQ-bEQujpNiNs,82
+sphinxext_bsb-5.0.0.dist-info/METADATA,sha256=nNWYixTy_y34Zd_q0SdkXVCXduNaU3bHEMNzWIfgzeQ,588
+sphinxext_bsb-5.0.0.dist-info/RECORD,,

{sphinxext_bsb-0.2.5.dist-info → sphinxext_bsb-5.0.0.dist-info}/WHEEL

@@ -1,4 +1,4 @@
 Wheel-Version: 1.0
-Generator: flit 3.11.0
+Generator: flit 3.12.0
 Root-Is-Purelib: true
 Tag: py3-none-any