README.md

@@ -101,7 +101,7 @@ For more details, see [Page mode](https://daizutabi.github.io/mkapi/usage/page/)
 [pypi-v-link]: https://pypi.org/project/mkapi/
 [python-v-image]: https://img.shields.io/pypi/pyversions/mkapi.svg
 [python-v-link]: https://pypi.org/project/mkapi
-[GHAction-image]: https://github.com/daizutabi/mkapi/actions/workflows/ci.yml/badge.svg?branch=main&event=push
+[GHAction-image]: https://github.com/daizutabi/mkapi/actions/workflows/ci.yaml/badge.svg?branch=main&event=push
 [GHAction-link]: https://github.com/daizutabi/mkapi/actions?query=event%3Apush+branch%3Amain
 [codecov-image]: https://codecov.io/github/daizutabi/mkapi/coverage.svg?branch=main
 [codecov-link]: https://codecov.io/github/daizutabi/mkapi?branch=main

pyproject.toml

@@ -4,11 +4,11 @@ build-backend = "hatchling.build"
 
 [project]
 name = "mkapi"
-version = "4.0.0"
-authors = [{ name = "daizutabi", email = "daizutabi@gmail.com" }]
+version = "4.0.1"
 description = "A plugin for MkDocs to generate API documentation"
 readme = "README.md"
 license = { file = "LICENSE" }
+authors = [{ name = "daizutabi", email = "daizutabi@gmail.com" }]
 classifiers = [
   "Development Status :: 5 - Production/Stable",
   "Framework :: MkDocs",
@@ -22,7 +22,7 @@ classifiers = [
 ]
 requires-python = ">=3.10"
 dependencies = [
-  "astdoc>=0.2.0",
+  "astdoc>=1.0.0",
   "jinja2",
   "mkdocs-material",
   "mkdocs>=1.6.0",
@@ -46,29 +46,11 @@ dev-dependencies = [
   "pytest-xdist",
 ]
 
-[tool.hatch.build.targets.sdist]
-exclude = ["/.github", "/docs"]
-
-[tool.hatch.build.targets.wheel]
-packages = ["src/mkapi"]
-
 [tool.pytest.ini_options]
 addopts = ["--doctest-modules", "--cov=mkapi", "--cov-report=lcov:lcov.info"]
-doctest_optionflags = ["NORMALIZE_WHITESPACE", "IGNORE_EXCEPTION_DETAIL"]
-filterwarnings = [
-  'ignore:datetime.datetime.utcfromtimestamp\(\) is deprecated:DeprecationWarning',
-  'ignore:\nPyarrow will become a required dependency:DeprecationWarning',
-]
-
-[tool.coverage.run]
-disable_warnings = ["module-not-measured"]
 
 [tool.coverage.report]
-exclude_lines = [
-  "except ImportError",
-  "if TYPE_CHECKING:",
-  "raise NotImplementedError",
-]
+exclude_lines = ["if TYPE_CHECKING:", "raise NotImplementedError"]
 skip_covered = true
 
 [tool.ruff]
@@ -85,7 +67,9 @@ ignore = [
   "ANN003",
   "ARG001",
   "ARG002",
-  "D",
+  "D105",
+  "D203",
+  "D213",
   "FBT001",
   "FBT002",
   "PERF401",
@@ -95,4 +79,6 @@ ignore = [
 ]
 
 [tool.ruff.lint.per-file-ignores]
-"tests/*" = ["ANN", "ARG", "FBT", "PLR", "RUF", "S"]
+"config.py" = ["D401"]
+"src/mkapi/plugin.py" = ["D"]
+"tests/*" = ["ANN", "ARG", "D", "FBT", "PLR", "RUF", "S"]

tests/test_plugin.py

@@ -18,7 +18,7 @@
 
 @pytest.fixture(scope="module")
 def config_file():
-    return Path(__file__).parent.parent / "mkdocs.yml"
+    return Path(__file__).parent.parent / "mkdocs.yaml"
 
 
 def test_config_file_exists(config_file: Path):
@@ -39,7 +39,7 @@ def test_mkdocs_config(mkdocs_config: MkDocsConfig):
     config = mkdocs_config
     assert isinstance(config, MkDocsConfig)
     path = Path(config.config_file_path)
-    assert path.as_posix().endswith("mkapi/mkdocs.yml")
+    assert path.as_posix().endswith("mkapi/mkdocs.yaml")
     assert config.site_name == "MkAPI"
     assert Path(config.docs_dir) == path.parent / "docs"
     assert Path(config.site_dir) == path.parent / "site"
@@ -90,15 +90,15 @@ def test_mkapi_config(mkapi_config: MkApiConfig):
 def config_plugin(tmp_path):
     dest = Path(tmp_path)
     root = Path(__file__).parent.parent
-    config_file = root / "mkdocs.yml"
+    config_file = root / "mkdocs.yaml"
     shutil.copy(config_file, dest)
     for src in ["docs", "src", "tests"]:
         src_dir = root / src
         shutil.copytree(src_dir, dest / src)
     curdir = Path(os.curdir).absolute()
     os.chdir(dest)
     sys.path.insert(0, ".")
-    config = load_config("mkdocs.yml")
+    config = load_config("mkdocs.yaml")
     plugin = config.plugins["mkapi"]
     assert isinstance(plugin, MkApiPlugin)
     plugin.__init__()