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

{ lib
, buildPythonPackage
, pythonOlder
, fetchFromGitHub
# propagatedBuildInputs
, Babel
, alabaster
, docutils
, imagesize
, jinja2
, packaging
, pygments
, requests
, setuptools
, snowballstemmer
, sphinxcontrib-applehelp
, sphinxcontrib-devhelp
, sphinxcontrib-htmlhelp
, sphinxcontrib-jsmath
, sphinxcontrib-qthelp
, sphinxcontrib-serializinghtml
, sphinxcontrib-websupport
# check phase
, html5lib
, imagemagick
, pytestCheckHook
, typed-ast
}:

buildPythonPackage rec {
  pname = "sphinx";
  version = "3.5.4";
  disabled = pythonOlder "3.5";

  src = fetchFromGitHub {
    owner = "sphinx-doc";
    repo = pname;
    rev = "v${version}";
    sha256 = "1xjii3dl01rq8x2bsxc6zywiy1s7arfgxrg5l8ml54w1748shadd";
  };

  propagatedBuildInputs = [
    Babel
    alabaster
    docutils
    imagesize
    jinja2
    packaging
    pygments
    requests
    setuptools
    snowballstemmer
    sphinxcontrib-applehelp
    sphinxcontrib-devhelp
    sphinxcontrib-htmlhelp
    sphinxcontrib-jsmath
    sphinxcontrib-qthelp
    sphinxcontrib-serializinghtml
    # extra[docs]
    sphinxcontrib-websupport
  ];

  checkInputs = [
    imagemagick
    html5lib
    pytestCheckHook
  ] ++ lib.optionals (pythonOlder "3.8") [
    typed-ast
  ];

  disabledTests = [
    # requires network access
    "test_anchors_ignored"
    "test_defaults"
    "test_defaults_json"
    "test_latex_images"
  ];

  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 = with maintainers; [ ];
  };
}
python.pkgs.sphinx: move expression 2017-08-11 23:55:59 -07:00			`{ lib`
			`, buildPythonPackage`
			`, pythonOlder`
python3Packages.sphinx: fix build, enable tests, cleanup 2021-05-08 05:34:58 -07:00			`, fetchFromGitHub`
			`# propagatedBuildInputs`
			`, Babel`
			`, alabaster`
python.pkgs.sphinx: move expression 2017-08-11 23:55:59 -07:00			`, docutils`
python3Packages.sphinx: fix build, enable tests, cleanup 2021-05-08 05:34:58 -07:00			`, imagesize`
python.pkgs.sphinx: move expression 2017-08-11 23:55:59 -07:00			`, jinja2`
python3Packages.sphinx: fix build, enable tests, cleanup 2021-05-08 05:34:58 -07:00			`, packaging`
python.pkgs.sphinx: move expression 2017-08-11 23:55:59 -07:00			`, pygments`
			`, requests`
python3Packages.sphinx: fix build, enable tests, cleanup 2021-05-08 05:34:58 -07:00			`, setuptools`
			`, snowballstemmer`
python3Packages.sphinx: 1.8.3 -> 2.2.0 and update the Python 2 version to 1.8.5 Motivation: http://www.sphinx-doc.org/en/master/changes.html#release-2-2-0-released-aug-19-2019 2019-10-21 15:41:10 -07:00			`, sphinxcontrib-applehelp`
			`, sphinxcontrib-devhelp`
			`, sphinxcontrib-htmlhelp`
			`, sphinxcontrib-jsmath`
			`, sphinxcontrib-qthelp`
			`, sphinxcontrib-serializinghtml`
python.pkgs: many updates 2017-08-24 10:34:20 -07:00			`, sphinxcontrib-websupport`
python3Packages.sphinx: fix build, enable tests, cleanup 2021-05-08 05:34:58 -07:00			`# check phase`
			`, html5lib`
			`, imagemagick`
			`, pytestCheckHook`
			`, typed-ast`
python.pkgs.sphinx: move expression 2017-08-11 23:55:59 -07:00			`}:`

			`buildPythonPackage rec {`
sphinx: don't use capital for pname 2018-11-04 15:49:33 -08:00			`pname = "sphinx";`
python3Packages.sphinx: 3.3.1 -> 3.5.4 2021-04-16 10:08:47 -07:00			`version = "3.5.4";`
python3Packages.sphinx: fix build, enable tests, cleanup 2021-05-08 05:34:58 -07:00			`disabled = pythonOlder "3.5";`

			`src = fetchFromGitHub {`
			`owner = "sphinx-doc";`
			`repo = pname;`
			`rev = "v${version}";`
			`sha256 = "1xjii3dl01rq8x2bsxc6zywiy1s7arfgxrg5l8ml54w1748shadd";`
python.pkgs.sphinx: move expression 2017-08-11 23:55:59 -07:00			`};`
python.pkgs: many updates 2017-08-24 10:34:20 -07:00
python.pkgs.sphinx: move expression 2017-08-11 23:55:59 -07:00			`propagatedBuildInputs = [`
python3Packages.sphinx: fix build, enable tests, cleanup 2021-05-08 05:34:58 -07:00			`Babel`
			`alabaster`
python.pkgs.sphinx: move expression 2017-08-11 23:55:59 -07:00			`docutils`
python3Packages.sphinx: fix build, enable tests, cleanup 2021-05-08 05:34:58 -07:00			`imagesize`
python.pkgs.sphinx: move expression 2017-08-11 23:55:59 -07:00			`jinja2`
python3Packages.sphinx: add missing dep packaging 2021-03-20 06:54:36 -07:00			`packaging`
python3Packages.sphinx: fix build, enable tests, cleanup 2021-05-08 05:34:58 -07:00			`pygments`
			`requests`
python.pkgs.sphinx: requires setuptools sphinx has setuptools (pkg_resources) as a runtime-dependency 2019-09-08 07:34:51 -07:00			`setuptools`
python.pkgs.sphinx: move expression 2017-08-11 23:55:59 -07:00			`snowballstemmer`
python3Packages.sphinx: 1.8.3 -> 2.2.0 and update the Python 2 version to 1.8.5 Motivation: http://www.sphinx-doc.org/en/master/changes.html#release-2-2-0-released-aug-19-2019 2019-10-21 15:41:10 -07:00			`sphinxcontrib-applehelp`
			`sphinxcontrib-devhelp`
			`sphinxcontrib-htmlhelp`
			`sphinxcontrib-jsmath`
			`sphinxcontrib-qthelp`
			`sphinxcontrib-serializinghtml`
python3Packages.sphinx: fix build, enable tests, cleanup 2021-05-08 05:34:58 -07:00			`# extra[docs]`
python.pkgs: many updates 2017-08-24 10:34:20 -07:00			`sphinxcontrib-websupport`
python3Packages.sphinx: fix build, enable tests, cleanup 2021-05-08 05:34:58 -07:00			`];`

			`checkInputs = [`
			`imagemagick`
			`html5lib`
			`pytestCheckHook`
			`] ++ lib.optionals (pythonOlder "3.8") [`
			`typed-ast`
			`];`
python.pkgs.sphinx: move expression 2017-08-11 23:55:59 -07:00
python3Packages.sphinx: fix build, enable tests, cleanup 2021-05-08 05:34:58 -07:00			`disabledTests = [`
			`# requires network access`
			`"test_anchors_ignored"`
			`"test_defaults"`
			`"test_defaults_json"`
			`"test_latex_images"`
			`];`
python.pkgs: many updates 2017-08-24 10:34:20 -07:00
python3Packages.sphinx: fix build, enable tests, cleanup 2021-05-08 05:34:58 -07:00			`meta = with lib; {`
			`description = "Python documentation generator";`
			`longDescription = ''`
			`A tool that makes it easy to create intelligent and beautiful`
			`documentation for Python projects`
			`'';`
python3Packages.sphinx: 3.3.1 -> 3.5.4 2021-04-16 10:08:47 -07:00			`homepage = "https://www.sphinx-doc.org";`
python3Packages.sphinx: fix build, enable tests, cleanup 2021-05-08 05:34:58 -07:00			`license = licenses.bsd3;`
treewide: remove nand0p as maintainer While looking at the sphinx package I noticed it was heavily undermaintained, which is when we noticed nand0p has been inactive for roughly 18 months. It is therefore prudent to assume they will not be maintaining their packages, modules and tests. - Their last contribution to nixpkgs was in 2019/12 - On 2021/05/08 I wrote them an email to the address listed in the maintainer-list, which they didn't reply to. 2021-05-14 07:00:41 -07:00			`maintainers = with maintainers; [ ];`
python.pkgs.sphinx: move expression 2017-08-11 23:55:59 -07:00			`};`
treewide: removed name from a few pythonpackages defining pname and version 2018-06-06 13:07:04 -07:00			`}`