sphinxext-bsb 0.2.2__tar.gz → 0.2.3__tar.gz

sphinxext_bsb-0.2.3/PKG-INFO

@@ -0,0 +1,13 @@
+Metadata-Version: 2.4
+Name: sphinxext-bsb
+Version: 0.2.3
+Summary: BSB Sphinx documentation extension
+Requires-Python: >=3.9,<3.12
+Description-Content-Type: text/markdown
+Requires-Dist: bsb-core
+Requires-Dist: sphinx-design~=0.5
+
+# sphinxext-bsb
+
+Project description here.
+

sphinxext_bsb-0.2.3/README.md

@@ -0,0 +1,3 @@
+# sphinxext-bsb
+
+Project description here.

sphinxext_bsb-0.2.3/project.json

@@ -0,0 +1,97 @@
+{
+  "name": "sphinxext-bsb",
+  "$schema": "../node_modules/nx/schemas/project-schema.json",
+  "projectType": "library",
+  "sourceRoot": "sphinxext-bsb/sphinxext_bsb",
+  "targets": {
+    "lock": {
+      "executor": "@nxlv/python:lock",
+      "options": {
+        "update": false
+      }
+    },
+    "sync": {
+      "executor": "@nxlv/python:sync",
+      "options": {}
+    },
+    "add": {
+      "executor": "@nxlv/python:add",
+      "options": {}
+    },
+    "update": {
+      "executor": "@nxlv/python:update",
+      "options": {}
+    },
+    "remove": {
+      "executor": "@nxlv/python:remove",
+      "options": {}
+    },
+    "build": {
+      "executor": "@nxlv/python:build",
+      "outputs": [
+        "{projectRoot}/dist"
+      ],
+      "options": {
+        "outputPath": "{projectRoot}/dist",
+        "publish": true,
+        "lockedVersions": false,
+        "bundleLocalDependencies": false
+      },
+      "cache": true
+    },
+    "lint": {
+      "executor": "@nxlv/python:ruff-check",
+      "outputs": [],
+      "options": {
+        "lintFilePatterns": [
+          "sphinxext_bsb",
+          "tests"
+        ]
+      },
+      "cache": true
+    },
+    "format": {
+      "executor": "@nxlv/python:ruff-format",
+      "outputs": [],
+      "options": {
+        "filePatterns": [
+          "sphinxext_bsb",
+          "tests"
+        ]
+      },
+      "cache": true
+    },
+    "test": {
+      "executor": "@nxlv/python:run-commands",
+      "outputs": [
+        "{workspaceRoot}/reports/{projectRoot}/unittests",
+        "{workspaceRoot}/coverage/{projectRoot}"
+      ],
+      "options": {
+        "command": "uv run pytest tests/",
+        "cwd": "{projectRoot}"
+      },
+      "cache": true
+    },
+    "install": {
+      "executor": "@nxlv/python:install",
+      "options": {
+        "silent": false,
+        "args": "",
+        "verbose": false,
+        "debug": false
+      }
+    },
+    "nx-release-publish": {
+      "executor": "@nxlv/python:publish",
+      "options": {},
+      "outputs": []
+    }
+  },
+  "tags": [],
+  "release": {
+    "version": {
+      "generator": "@nxlv/python:release-version"
+    }
+  }
+}

sphinxext_bsb-0.2.3/pyproject.toml

@@ -0,0 +1,79 @@
+[tool.coverage.run]
+branch = true
+source = [ "sphinxext_bsb" ]
+
+[tool.coverage.report]
+exclude_lines = ['if TYPE_CHECKING:']
+show_missing = true
+
+[tool.pytest.ini_options]
+addopts = """
+ --cov
+ --cov-report html:'../coverage/sphinxext-bsb/html'
+ --cov-report xml:'../coverage/sphinxext-bsb/coverage.xml'
+ --html='../reports/sphinxext-bsb/unittests/html/index.html'
+ --junitxml='../reports/sphinxext-bsb/unittests/junit.xml'
+"""
+
+[project]
+name = "sphinxext-bsb"
+version = "0.2.3"
+description = "BSB Sphinx documentation extension"
+requires-python = ">=3.9,<3.12"
+readme = 'README.md'
+dependencies = [
+    "bsb-core",
+    "sphinx-design~=0.5",
+]
+
+[tool.flit.module]
+name = "sphinxext.bsb"
+
+[dependency-groups]
+dev = [
+  "autopep8>=2.3.1",
+  "ruff>=0.8.2",
+  "pytest>=8.3.4",
+  "pytest-sugar>=1.0.0",
+  "pytest-cov>=6.0.0",
+  "pytest-html>=4.1.1",
+]
+
+[build-system]
+requires = ["flit>=3.5"]
+build-backend = "flit.buildapi"
+
+[tool.ruff]
+exclude = [
+  ".ruff_cache",
+  ".svn",
+  ".tox",
+  ".venv",
+  "dist",
+]
+
+line-length = 88
+indent-width = 4
+
+[tool.ruff.lint]
+select = [
+  # pycodestyle
+  "E",
+  # Pyflakes
+  "F",
+  # pyupgrade
+  "UP",
+  # flake8-bugbear
+  "B",
+  # flake8-simplify
+  "SIM",
+  # isort
+  "I",
+]
+ignore = []
+
+fixable = ["ALL"]
+unfixable = []
+
+[tool.uv.sources]
+bsb-core = { path = "../../packages/bsb-core", editable = true }

sphinxext-bsb-0.2.2/bsbdocs.py → sphinxext_bsb-0.2.3/sphinxext/bsb/__init__.py

@@ -173,7 +173,6 @@ class AutoconfigDirective(SphinxDirective):
             untree = self.dict_untree(untree)
         return untree, value
 
-
     def guess_example_value(self, attr):
         type_ = self.get_attr_type(attr)
         # The attribute may have a hinted example from the declaration `hint` kwarg,

sphinxext-bsb-0.2.2/LICENSE

@@ -1,21 +0,0 @@
-MIT License
-
-Copyright (c) 2022 Robin De Schepper
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.

sphinxext-bsb-0.2.2/PKG-INFO

@@ -1,6 +0,0 @@
-Metadata-Version: 2.1
-Name: sphinxext-bsb
-Version: 0.2.2
-Summary: BSB Sphinx documentation extension
-License-File: LICENSE
-Requires-Dist: sphinx-design

sphinxext-bsb-0.2.2/README.md

@@ -1,2 +0,0 @@
-# sphinxext-bsb
-Sphinx extension for the BSB documentation

sphinxext-bsb-0.2.2/pyproject.toml

@@ -1,11 +0,0 @@
-[build-system]
-requires = ["setuptools"]
-build-backend = "setuptools.build_meta"
-
-[project]
-name = "sphinxext-bsb"
-description = "BSB Sphinx documentation extension"
-version = "0.2.2"
-dependencies = [
-    "sphinx-design"
-]

sphinxext-bsb-0.2.2/setup.cfg

@@ -1,4 +0,0 @@
-[egg_info]
-tag_build = 
-tag_date = 0
-

sphinxext-bsb-0.2.2/sphinxext_bsb.egg-info/PKG-INFO

@@ -1,6 +0,0 @@
-Metadata-Version: 2.1
-Name: sphinxext-bsb
-Version: 0.2.2
-Summary: BSB Sphinx documentation extension
-License-File: LICENSE
-Requires-Dist: sphinx-design

sphinxext-bsb-0.2.2/sphinxext_bsb.egg-info/SOURCES.txt

@@ -1,9 +0,0 @@
-LICENSE
-README.md
-bsbdocs.py
-pyproject.toml
-sphinxext_bsb.egg-info/PKG-INFO
-sphinxext_bsb.egg-info/SOURCES.txt
-sphinxext_bsb.egg-info/dependency_links.txt
-sphinxext_bsb.egg-info/requires.txt
-sphinxext_bsb.egg-info/top_level.txt

sphinxext-bsb-0.2.2/sphinxext_bsb.egg-info/dependency_links.txt

@@ -1 +0,0 @@
-

sphinxext-bsb-0.2.2/sphinxext_bsb.egg-info/requires.txt

@@ -1 +0,0 @@
-sphinx-design

sphinxext-bsb-0.2.2/sphinxext_bsb.egg-info/top_level.txt

@@ -1 +0,0 @@
-bsbdocs