pkgs/development/python-modules/sphinx-mdinclude/default.nix

   1 {
   2   lib,
   3   buildPythonPackage,
   4   fetchPypi,
   5
   6   # build-system
   7   flit-core,
   8
   9   # dependencies
  10   docutils,
  11   mistune,
  12   pygments,
  13
  14   # tests
  15   pytestCheckHook,
  16 }:
  17
  18 buildPythonPackage rec {
  19   pname = "sphinx-mdinclude";
  20   version = "0.6.1";
  21   format = "pyproject";
  22
  23   src = fetchPypi {
  24     pname = "sphinx_mdinclude";
  25     inherit version;
  26     hash = "sha256-7OPYEuLVWbTn5H9ntqh7Dipom2svURR5XI7Uf/s5wWk=";
  27   };
  28
  29   nativeBuildInputs = [ flit-core ];
  30
  31   propagatedBuildInputs = [
  32     docutils
  33     mistune
  34     pygments
  35   ];
  36
  37   nativeCheckInputs = [ pytestCheckHook ];
  38
  39   meta = with lib; {
  40     broken = true; # https://github.com/omnilib/sphinx-mdinclude/issues/22
  41     homepage = "https://github.com/omnilib/sphinx-mdinclude";
  42     changelog = "https://github.com/omnilib/sphinx-mdinclude/blob/v${version}/CHANGELOG.md";
  43     description = "Sphinx extension for including or writing pages in Markdown format";
  44     longDescription = ''
  45       A simple Sphinx extension that enables including Markdown documents from within
  46       reStructuredText.
  47       It provides the .. mdinclude:: directive, and automatically converts the content of
  48       Markdown documents to reStructuredText format.
  49
  50       sphinx-mdinclude is a fork of m2r and m2r2, focused only on providing a Sphinx extension.
  51     '';
  52     license = licenses.mit;
  53     maintainers = with maintainers; [ flokli ];
  54   };
  55 }