.devcontainer/devcontainer.json

@@ -1,15 +1,16 @@
 {
-  "image": "mcr.microsoft.com/vscode/devcontainers/python:3.12",
+  "image": "mcr.microsoft.com/vscode/devcontainers/base:ubuntu24.04",
   "features": {
-    "ghcr.io/devcontainers-contrib/features/starship:1": {},
-    "ghcr.io/va-h/devcontainers-features/uv:1": {}
+    "ghcr.io/devcontainers-contrib/features/starship:1": {}
   },
   "customizations": {
     "vscode": {
       "extensions": [
         "charliermarsh.ruff",
+        "fill-labs.dependi",
         "ms-python.python",
-        "ms-python.vscode-pylance"
+        "ms-python.vscode-pylance",
+        "tamasfe.even-better-toml"
       ]
     }
   },

.devcontainer/postCreate.sh

@@ -1,5 +1,11 @@
-#!/bin/sh
+#!/bin/bash
 
 echo 'eval "$(starship init bash)"' >> ~/.bashrc
+echo "alias ll='ls -alF'" >> ~/.bashrc
 mkdir -p ~/.config
-cp .devcontainer/starship.toml ~/.config
+cp .devcontainer/starship.toml ~/.config
+
+curl -LsSf https://astral.sh/uv/install.sh | sh
+curl -LsSf https://astral.sh/ruff/install.sh | sh
+source $HOME/.cargo/env
+echo 'eval "$(uv generate-shell-completion bash)"' >> ~/.bashrc

.github/workflows/ci.yml

@@ -30,12 +30,12 @@ jobs:
         with:
           python-version: ${{ matrix.python-version }}
           allow-prereleases: true
-      - name: Install uv
-        run: pip install uv
+      - name: Install uv and ruff
+        run: pip install uv ruff
       - name: Install the project
         run: uv sync
       - name: Ruff check
-        run: uv run ruff check .
+        run: ruff check
       - name: Run test
         run: uv run pytest -n 8 --junitxml=junit.xml
       - name: Upload Codecov Results

example/mod_a.py

@@ -11,11 +11,18 @@
 
 
 class ClassA:
-    """Class A."""
 
     attr_a: str = "string"
     """Attribute A."""
 
+    def __init__(self, a: str):
+        """Class A.
+
+        Args:
+            a: A string.
+        """
+        self.attr_a = a
+
     def method_a(self, x: Iterable[str], y: ClassB) -> ClassA:
         """Method A. Return `ClassA`.
 

pyproject.toml

@@ -4,11 +4,11 @@ build-backend = "hatchling.build"
 
 [project]
 name = "mkapi"
-version = "3.0.22"
+version = "3.0.23"
 authors = [{ name = "daizutabi", email = "daizutabi@gmail.com" }]
 description = "A plugin for MkDocs to generate API documentation"
 readme = "README.md"
-license = "MIT"
+license = { file = "LICENSE" }
 classifiers = [
   "Development Status :: 5 - Production/Stable",
   "Framework :: MkDocs",
@@ -43,7 +43,6 @@ dev-dependencies = [
   "pytest-cov",
   "pytest-randomly",
   "pytest-xdist",
-  "ruff",
 ]
 
 [tool.hatch.build.targets.sdist]
@@ -79,6 +78,7 @@ exclude = ["tests/examples/*.py", "example/*.py"]
 select = ["ALL"]
 unfixable = ["F401"]
 ignore = [
+  "A005",
   "ANN002",
   "ANN003",
   "ARG001",

src/mkapi/parser.py

@@ -619,7 +619,7 @@ def _iter_signature(
     prev_kind = None
 
     for k, param in enumerate(obj.parameters):
-        if k == 0 and obj.kind in ["class", "method", "classmethod"]:
+        if k == 0 and obj.kind in ["method", "classmethod"]:
             continue
 
         yield from _iter_sep(param.kind, prev_kind)

src/mkapi/renderer.py

@@ -246,12 +246,13 @@ def _get_source(
             continue
 
         if (
-            skip_self
-            and child is obj
+            (skip_self and child is obj)
             or isinstance(obj, Attribute)
             or not child.node
-            or child != obj
-            and (not is_child(child, obj) or child.module is not module)
+            or (
+                child != obj
+                and (not is_child(child, obj) or child.module is not module)
+            )
         ):
             continue
 

tests/parser/test_signature.py

@@ -103,3 +103,13 @@ def test_get_signature_skip_self():
     s = get_signature(obj)  # type: ignore
     assert s[0].name == "("  # no self
     assert s[1].name == ")"
+
+
+def test_get_signature_dont_skip_self_class():
+    from mkapi.object import get_object
+    from mkapi.parser import get_signature
+
+    obj = get_object("example.sub.ClassA")
+    s = get_signature(obj)  # type: ignore
+    assert s[0].name == "("
+    assert s[1].name == "a"