diff --git a/pkgs/development/python-modules/mkdocstrings/default.nix b/pkgs/development/python-modules/mkdocstrings/default.nix new file mode 100644 index 00000000000..b151727a8fb --- /dev/null +++ b/pkgs/development/python-modules/mkdocstrings/default.nix @@ -0,0 +1,66 @@ +{ lib +, buildPythonApplication +, fetchFromGitHub +, jinja2 +, markdown +, markupsafe +, mkdocs +, mkdocs-autorefs +, pymdown-extensions +, pytestCheckHook +, pdm-pep517 +, pythonOlder +}: + +buildPythonApplication rec { + pname = "mkdocstrings"; + version = "0.19.0"; + format = "pyproject"; + + disabled = pythonOlder "3.7"; + + src = fetchFromGitHub { + owner = "mkdocstrings"; + repo = pname; + rev = version; + sha256 = "sha256-7OF1CrRnE4MYHuYD/pasnZpLe9lrbieGp4agnWAaKVo="; + }; + + nativeBuildInputs = [ + pdm-pep517 + ]; + + propagatedBuildInputs = [ + jinja2 + markdown + markupsafe + mkdocs + mkdocs-autorefs + pymdown-extensions + ]; + + checkInputs = [ + pytestCheckHook + ]; + + postPatch = '' + substituteInPlace pyproject.toml \ + --replace 'dynamic = ["version"]' 'version = "${version}"' + ''; + + pythonImportsCheck = [ + "mkdocstrings" + ]; + + disabledTestPaths = [ + # Circular dependencies + "tests/test_extension.py" + ]; + + meta = with lib; { + description = "Automatic documentation from sources for MkDocs"; + homepage = "https://github.com/mkdocstrings/mkdocstrings"; + license = licenses.isc; + maintainers = with maintainers; [ fab ]; + }; +} diff --git a/pkgs/top-level/python-packages.nix b/pkgs/top-level/python-packages.nix index 0acea21f315..40042ed7052 100644 --- a/pkgs/top-level/python-packages.nix +++ b/pkgs/top-level/python-packages.nix @@ -5447,6 +5447,7 @@ in { mkdocs-material-extensions = callPackage ../development/python-modules/mkdocs-material/mkdocs-material-extensions.nix { }; mkdocs-minify = callPackage ../development/python-modules/mkdocs-minify { }; mkdocs-redirects = callPackage ../development/python-modules/mkdocs-redirects { }; + mkdocstrings = callPackage ../development/python-modules/mkdocstrings { }; mkl-service = callPackage ../development/python-modules/mkl-service { };