Files
nixpkgs/pkgs/development/python-modules/sphinx/default.nix
Guillaume Girol 33afbf39f6 treewide: switch to nativeCheckInputs
checkInputs used to be added to nativeBuildInputs. Now we have
nativeCheckInputs to do that instead. Doing this treewide change allows
to keep hashes identical to before the introduction of
nativeCheckInputs.
2023-01-21 12:00:00 +00:00

145 lines
3.4 KiB
Nix

{ stdenv
, lib
, buildPythonPackage
, pythonOlder
, fetchFromGitHub
, fetchpatch
# nativeBuildInputs
, flit-core
# propagatedBuildInputs
, babel
, alabaster
, docutils
, imagesize
, importlib-metadata
, jinja2
, packaging
, pygments
, requests
, snowballstemmer
, sphinxcontrib-apidoc
, sphinxcontrib-applehelp
, sphinxcontrib-devhelp
, sphinxcontrib-htmlhelp
, sphinxcontrib-jsmath
, sphinxcontrib-qthelp
, sphinxcontrib-serializinghtml
, sphinxcontrib-websupport
# check phase
, cython
, html5lib
, pytestCheckHook
, typed-ast
}:
buildPythonPackage rec {
pname = "sphinx";
version = "5.3.0";
format = "pyproject";
disabled = pythonOlder "3.6";
src = fetchFromGitHub {
owner = "sphinx-doc";
repo = pname;
rev = "refs/tags/v${version}";
hash = "sha256-80bVg1rfBebgSOKbWkzP84vpm39iLgM8lWlVD64nSsQ=";
postFetch = ''
cd $out
mv tests/roots/test-images/testimäge.png \
tests/roots/test-images/testimæge.png
patch -p1 < ${./0001-test-images-Use-normalization-equivalent-character.patch}
'';
};
nativeBuildInputs = [
flit-core
];
propagatedBuildInputs = [
babel
alabaster
docutils
imagesize
jinja2
packaging
pygments
requests
snowballstemmer
sphinxcontrib-applehelp
sphinxcontrib-devhelp
sphinxcontrib-htmlhelp
sphinxcontrib-jsmath
sphinxcontrib-qthelp
sphinxcontrib-serializinghtml
# extra[docs]
sphinxcontrib-websupport
# extra plugins which are otherwise not found by sphinx-build
sphinxcontrib-apidoc
] ++ lib.optionals (pythonOlder "3.10") [
importlib-metadata
];
nativeCheckInputs = [
cython
html5lib
pytestCheckHook
] ++ lib.optionals (pythonOlder "3.8") [
typed-ast
];
preCheck = ''
export HOME=$(mktemp -d)
'';
disabledTests = [
# requires network access
"test_anchors_ignored"
"test_defaults"
"test_defaults_json"
"test_latex_images"
# requires imagemagick (increases build closure size), doesn't
# test anything substantial
"test_ext_imgconverter"
] ++ lib.optionals stdenv.isDarwin [
# Due to lack of network sandboxing can't guarantee port 7777 isn't bound
"test_inspect_main_url"
"test_auth_header_uses_first_match"
"test_linkcheck_allowed_redirects"
"test_linkcheck_request_headers"
"test_linkcheck_request_headers_no_slash"
"test_follows_redirects_on_HEAD"
"test_get_after_head_raises_connection_error"
"test_invalid_ssl"
"test_connect_to_selfsigned_with_tls_verify_false"
"test_connect_to_selfsigned_with_tls_cacerts"
"test_connect_to_selfsigned_with_requests_env_var"
"test_connect_to_selfsigned_nonexistent_cert_file"
"test_TooManyRedirects_on_HEAD"
"test_too_many_requests_retry_after_int_del"
"test_too_many_requests_retry_after_HTTP_date"
"test_too_many_requests_retry_after_without_header"
"test_too_many_requests_user_timeout"
"test_raises_for_invalid_status"
"test_auth_header_no_match"
"test_follows_redirects_on_GET"
"test_connect_to_selfsigned_fails"
];
meta = with lib; {
description = "Python documentation generator";
longDescription = ''
A tool that makes it easy to create intelligent and beautiful
documentation for Python projects
'';
homepage = "https://www.sphinx-doc.org";
license = licenses.bsd3;
maintainers = teams.sphinx.members;
};
}