Read the Docs build information Build id: 236272 Project: icb-anndata Version: latest Commit: 926b82d9144a61bab4aa3c6ef0848d256b39c3bf Date: 2019-08-27T09:29:40.078056Z State: finished Success: False [rtd-command-info] start-time: 2019-08-27T09:29:40.578978Z, end-time: 2019-08-27T09:29:41.121380Z, duration: 0, exit-code: 0 git clone --no-single-branch --depth 50 https://github.com/theislab/anndata.git . Cloning into '.'... [rtd-command-info] start-time: 2019-08-27T09:29:41.405015Z, end-time: 2019-08-27T09:29:41.415664Z, duration: 0, exit-code: 0 git checkout --force origin/master Note: checking out 'origin/master'. You are in 'detached HEAD' state. You can look around, make experimental changes and commit them, and you can discard any commits you make in this state without impacting any branches by performing another checkout. If you want to create a new branch to retain commits you create, you may do so (now or later) by using -b with the checkout command again. Example: git checkout -b HEAD is now at 926b82d Fixed some links [rtd-command-info] start-time: 2019-08-27T09:29:41.512927Z, end-time: 2019-08-27T09:29:41.521243Z, duration: 0, exit-code: 0 git clean -d -f -f [rtd-command-info] start-time: 2019-08-27T09:29:42.547009Z, end-time: 2019-08-27T09:29:47.166075Z, duration: 4, exit-code: 0 python3.6 -mvirtualenv --no-site-packages --no-download Using base prefix '/home/docs/.pyenv/versions/3.6.8' New python executable in /home/docs/checkouts/readthedocs.org/user_builds/icb-anndata/envs/latest/bin/python3.6 Also creating executable in /home/docs/checkouts/readthedocs.org/user_builds/icb-anndata/envs/latest/bin/python Installing setuptools, pip, wheel... done. [rtd-command-info] start-time: 2019-08-27T09:29:47.247632Z, end-time: 2019-08-27T09:29:49.783171Z, duration: 2, exit-code: 0 python -m pip install --upgrade --cache-dir /home/docs/checkouts/readthedocs.org/user_builds/icb-anndata/.cache/pip pip Collecting pip Downloading https://files.pythonhosted.org/packages/30/db/9e38760b32e3e7f40cce46dd5fb107b8c73840df38f0046d8e6514e675a1/pip-19.2.3-py2.py3-none-any.whl (1.4MB) Installing collected packages: pip Found existing installation: pip 19.1.1 Uninstalling pip-19.1.1: Successfully uninstalled pip-19.1.1 Successfully installed pip-19.2.3 [rtd-command-info] start-time: 2019-08-27T09:29:49.860521Z, end-time: 2019-08-27T09:30:00.956730Z, duration: 11, exit-code: 0 python -m pip install --upgrade --cache-dir /home/docs/checkouts/readthedocs.org/user_builds/icb-anndata/.cache/pip Pygments==2.3.1 setuptools==41.0.1 docutils==0.14 mock==1.0.1 pillow==5.4.1 alabaster>=0.7,<0.8,!=0.7.5 commonmark==0.8.1 recommonmark==0.5.0 sphinx<2 sphinx-rtd-theme<0.5 readthedocs-sphinx-ext<1.1 Collecting Pygments==2.3.1 Downloading https://files.pythonhosted.org/packages/13/e5/6d710c9cf96c31ac82657bcfb441df328b22df8564d58d0c4cd62612674c/Pygments-2.3.1-py2.py3-none-any.whl (849kB) Requirement already up-to-date: setuptools==41.0.1 in /home/docs/checkouts/readthedocs.org/user_builds/icb-anndata/envs/latest/lib/python3.6/site-packages (41.0.1) Collecting docutils==0.14 Downloading https://files.pythonhosted.org/packages/36/fa/08e9e6e0e3cbd1d362c3bbee8d01d0aedb2155c4ac112b19ef3cae8eed8d/docutils-0.14-py3-none-any.whl (543kB) Collecting mock==1.0.1 Downloading https://files.pythonhosted.org/packages/a2/52/7edcd94f0afb721a2d559a5b9aae8af4f8f2c79bc63fdbe8a8a6c9b23bbe/mock-1.0.1.tar.gz (818kB) Collecting pillow==5.4.1 Downloading https://files.pythonhosted.org/packages/85/5e/e91792f198bbc5a0d7d3055ad552bc4062942d27eaf75c3e2783cf64eae5/Pillow-5.4.1-cp36-cp36m-manylinux1_x86_64.whl (2.0MB) Collecting alabaster!=0.7.5,<0.8,>=0.7 Downloading https://files.pythonhosted.org/packages/10/ad/00b090d23a222943eb0eda509720a404f531a439e803f6538f35136cae9e/alabaster-0.7.12-py2.py3-none-any.whl Collecting commonmark==0.8.1 Downloading https://files.pythonhosted.org/packages/ab/ca/439c88039583a29564a0043186875258e9a4f041fb5c422cd387b8e10175/commonmark-0.8.1-py2.py3-none-any.whl (47kB) Collecting recommonmark==0.5.0 Downloading https://files.pythonhosted.org/packages/9b/3d/92ea48401622510e57b4bdaa74dc9db2fb9e9e892324b48f9c02d716a93a/recommonmark-0.5.0-py2.py3-none-any.whl Collecting sphinx<2 Downloading https://files.pythonhosted.org/packages/7d/66/a4af242b4348b729b9d46ce5db23943ce9bca7da9bbe2ece60dc27f26420/Sphinx-1.8.5-py2.py3-none-any.whl (3.1MB) Collecting sphinx-rtd-theme<0.5 Downloading https://files.pythonhosted.org/packages/60/b4/4df37087a1d36755e3a3bfd2a30263f358d2dea21938240fa02313d45f51/sphinx_rtd_theme-0.4.3-py2.py3-none-any.whl (6.4MB) Collecting readthedocs-sphinx-ext<1.1 Downloading https://files.pythonhosted.org/packages/51/43/a5a98d9aec325b2824bdf504fa446ae876d0909d03e28667018f9eb01bcd/readthedocs_sphinx_ext-1.0.0-py2.py3-none-any.whl Collecting future (from commonmark==0.8.1) Downloading https://files.pythonhosted.org/packages/90/52/e20466b85000a181e1e144fd8305caf2cf475e2f9674e797b222f8105f5f/future-0.17.1.tar.gz (829kB) Collecting sphinxcontrib-websupport (from sphinx<2) Downloading https://files.pythonhosted.org/packages/2a/59/d64bda9b7480a84a3569be4dde267c0f6675b255ba63b4c8e84469940457/sphinxcontrib_websupport-1.1.2-py2.py3-none-any.whl Collecting snowballstemmer>=1.1 (from sphinx<2) Downloading https://files.pythonhosted.org/packages/a0/5e/d9ead2d57d39b3e1c1868ce84212319e5543a19c4185dce7e42a9dd968b0/snowballstemmer-1.9.0.tar.gz (76kB) Collecting six>=1.5 (from sphinx<2) Downloading https://files.pythonhosted.org/packages/73/fb/00a976f728d0d1fecfe898238ce23f502a721c0ac0ecfedb80e0d88c64e9/six-1.12.0-py2.py3-none-any.whl Collecting imagesize (from sphinx<2) Downloading https://files.pythonhosted.org/packages/fc/b6/aef66b4c52a6ad6ac18cf6ebc5731ed06d8c9ae4d3b2d9951f261150be67/imagesize-1.1.0-py2.py3-none-any.whl Collecting packaging (from sphinx<2) Downloading https://files.pythonhosted.org/packages/ec/22/630ac83e8f8a9566c4f88038447ed9e16e6f10582767a01f31c769d9a71e/packaging-19.1-py2.py3-none-any.whl Collecting Jinja2>=2.3 (from sphinx<2) Downloading https://files.pythonhosted.org/packages/1d/e7/fd8b501e7a6dfe492a433deb7b9d833d39ca74916fa8bc63dd1a4947a671/Jinja2-2.10.1-py2.py3-none-any.whl (124kB) Collecting requests>=2.0.0 (from sphinx<2) Downloading https://files.pythonhosted.org/packages/51/bd/23c926cd341ea6b7dd0b2a00aba99ae0f828be89d72b2190f27c11d4b7fb/requests-2.22.0-py2.py3-none-any.whl (57kB) Collecting babel!=2.0,>=1.3 (from sphinx<2) Downloading https://files.pythonhosted.org/packages/2c/60/f2af68eb046c5de5b1fe6dd4743bf42c074f7141fe7b2737d3061533b093/Babel-2.7.0-py2.py3-none-any.whl (8.4MB) Collecting attrs (from packaging->sphinx<2) Downloading https://files.pythonhosted.org/packages/23/96/d828354fa2dbdf216eaa7b7de0db692f12c234f7ef888cc14980ef40d1d2/attrs-19.1.0-py2.py3-none-any.whl Collecting pyparsing>=2.0.2 (from packaging->sphinx<2) Downloading https://files.pythonhosted.org/packages/11/fa/0160cd525c62d7abd076a070ff02b2b94de589f1a9789774f17d7c54058e/pyparsing-2.4.2-py2.py3-none-any.whl (65kB) Collecting MarkupSafe>=0.23 (from Jinja2>=2.3->sphinx<2) Downloading https://files.pythonhosted.org/packages/b2/5f/23e0023be6bb885d00ffbefad2942bc51a620328ee910f64abe5a8d18dd1/MarkupSafe-1.1.1-cp36-cp36m-manylinux1_x86_64.whl Collecting certifi>=2017.4.17 (from requests>=2.0.0->sphinx<2) Downloading https://files.pythonhosted.org/packages/69/1b/b853c7a9d4f6a6d00749e94eb6f3a041e342a885b87340b79c1ef73e3a78/certifi-2019.6.16-py2.py3-none-any.whl (157kB) Collecting urllib3!=1.25.0,!=1.25.1,<1.26,>=1.21.1 (from requests>=2.0.0->sphinx<2) Downloading https://files.pythonhosted.org/packages/e6/60/247f23a7121ae632d62811ba7f273d0e58972d75e58a94d329d51550a47d/urllib3-1.25.3-py2.py3-none-any.whl (150kB) Collecting idna<2.9,>=2.5 (from requests>=2.0.0->sphinx<2) Downloading https://files.pythonhosted.org/packages/14/2c/cd551d81dbe15200be1cf41cd03869a46fe7226e7450af7a6545bfc474c9/idna-2.8-py2.py3-none-any.whl (58kB) Collecting chardet<3.1.0,>=3.0.2 (from requests>=2.0.0->sphinx<2) Downloading https://files.pythonhosted.org/packages/bc/a9/01ffebfb562e4274b6487b4bb1ddec7ca55ec7510b22e4c51f14098443b8/chardet-3.0.4-py2.py3-none-any.whl (133kB) Collecting pytz>=2015.7 (from babel!=2.0,>=1.3->sphinx<2) Downloading https://files.pythonhosted.org/packages/87/76/46d697698a143e05f77bec5a526bf4e56a0be61d63425b68f4ba553b51f2/pytz-2019.2-py2.py3-none-any.whl (508kB) Building wheels for collected packages: mock, future, snowballstemmer Building wheel for mock (setup.py): started Building wheel for mock (setup.py): finished with status 'done' Created wheel for mock: filename=mock-1.0.1-cp36-none-any.whl size=23755 sha256=99af8b0ecc2495bfbcb4a7ed5eeb548c5499d34b38c86981cdd6e9259f1e6f13 Stored in directory: /home/docs/checkouts/readthedocs.org/user_builds/icb-anndata/.cache/pip/wheels/7e/72/92/744b532c779242b57aab4bcba80c312b30c069bbd60025e7e6 Building wheel for future (setup.py): started Building wheel for future (setup.py): finished with status 'done' Created wheel for future: filename=future-0.17.1-cp36-none-any.whl size=488730 sha256=a7885f1e5a3995c2d98970f72bf15f4b7c98650fd4311cd454dadeb8b8ee921b Stored in directory: /home/docs/checkouts/readthedocs.org/user_builds/icb-anndata/.cache/pip/wheels/0c/61/d2/d6b7317325828fbb39ee6ad559dbe4664d0896da4721bf379e Building wheel for snowballstemmer (setup.py): started Building wheel for snowballstemmer (setup.py): finished with status 'done' Created wheel for snowballstemmer: filename=snowballstemmer-1.9.0-cp36-none-any.whl size=93834 sha256=1ce5ba34a5780978931c02d6cdc2fcdaaa0fa8c64446790a3946650eb021db5c Stored in directory: /home/docs/checkouts/readthedocs.org/user_builds/icb-anndata/.cache/pip/wheels/93/db/97/496f1d6bbcad1fecbc58fe45363540414be519312eded82bab Successfully built mock future snowballstemmer Installing collected packages: Pygments, docutils, mock, pillow, alabaster, future, commonmark, sphinxcontrib-websupport, snowballstemmer, six, imagesize, attrs, pyparsing, packaging, MarkupSafe, Jinja2, certifi, urllib3, idna, chardet, requests, pytz, babel, sphinx, recommonmark, sphinx-rtd-theme, readthedocs-sphinx-ext Successfully installed Jinja2-2.10.1 MarkupSafe-1.1.1 Pygments-2.3.1 alabaster-0.7.12 attrs-19.1.0 babel-2.7.0 certifi-2019.6.16 chardet-3.0.4 commonmark-0.8.1 docutils-0.14 future-0.17.1 idna-2.8 imagesize-1.1.0 mock-1.0.1 packaging-19.1 pillow-5.4.1 pyparsing-2.4.2 pytz-2019.2 readthedocs-sphinx-ext-1.0.0 recommonmark-0.5.0 requests-2.22.0 six-1.12.0 snowballstemmer-1.9.0 sphinx-1.8.5 sphinx-rtd-theme-0.4.3 sphinxcontrib-websupport-1.1.2 urllib3-1.25.3 [rtd-command-info] start-time: 2019-08-27T09:30:01.043624Z, end-time: 2019-08-27T09:30:14.841509Z, duration: 13, exit-code: 0 python -m pip install --exists-action=w --cache-dir /home/docs/checkouts/readthedocs.org/user_builds/icb-anndata/.cache/pip -r docs/requires.txt Requirement already satisfied: sphinx>=1.8 in /home/docs/checkouts/readthedocs.org/user_builds/icb-anndata/envs/latest/lib/python3.6/site-packages (from -r docs/requires.txt (line 2)) (1.8.5) Collecting sphinx-autodoc-typehints (from -r docs/requires.txt (line 3)) Downloading https://files.pythonhosted.org/packages/ef/bb/b752dafd70eee82863773e3deaead5676a414fc513ebd898c19c8e3f8ade/sphinx_autodoc_typehints-1.7.0-py3-none-any.whl Collecting scanpydoc>=0.3.2 (from -r docs/requires.txt (line 4)) Downloading https://files.pythonhosted.org/packages/bd/c2/6f5fdf1e57a4bfcafac9b3571156e098d83867023fc0eff374eecdda4f32/scanpydoc-0.3.8-py3-none-any.whl (54kB) Collecting pandas~=0.21 (from -r docs/requires.txt (line 6)) Downloading https://files.pythonhosted.org/packages/73/9b/52e228545d14f14bb2a1622e225f38463c8726645165e1cb7dde95bfe6d4/pandas-0.25.1-cp36-cp36m-manylinux1_x86_64.whl (10.5MB) Collecting scipy (from -r docs/requires.txt (line 7)) Downloading https://files.pythonhosted.org/packages/29/50/a552a5aff252ae915f522e44642bb49a7b7b31677f9580cfd11bcc869976/scipy-1.3.1-cp36-cp36m-manylinux1_x86_64.whl (25.2MB) Collecting h5py (from -r docs/requires.txt (line 8)) Downloading https://files.pythonhosted.org/packages/30/99/d7d4fbf2d02bb30fb76179911a250074b55b852d34e98dd452a9f394ac06/h5py-2.9.0-cp36-cp36m-manylinux1_x86_64.whl (2.8MB) Collecting natsort (from -r docs/requires.txt (line 9)) Downloading https://files.pythonhosted.org/packages/e7/13/a66bfa0ebf00e17778ca0319d081be686a33384d1f612fc8e0fc542ac5d8/natsort-6.0.0-py2.py3-none-any.whl Requirement already satisfied: requests>=2.0.0 in /home/docs/checkouts/readthedocs.org/user_builds/icb-anndata/envs/latest/lib/python3.6/site-packages (from sphinx>=1.8->-r docs/requires.txt (line 2)) (2.22.0) Requirement already satisfied: imagesize in /home/docs/checkouts/readthedocs.org/user_builds/icb-anndata/envs/latest/lib/python3.6/site-packages (from sphinx>=1.8->-r docs/requires.txt (line 2)) (1.1.0) Requirement already satisfied: Pygments>=2.0 in /home/docs/checkouts/readthedocs.org/user_builds/icb-anndata/envs/latest/lib/python3.6/site-packages (from sphinx>=1.8->-r docs/requires.txt (line 2)) (2.3.1) Requirement already satisfied: sphinxcontrib-websupport in /home/docs/checkouts/readthedocs.org/user_builds/icb-anndata/envs/latest/lib/python3.6/site-packages (from sphinx>=1.8->-r docs/requires.txt (line 2)) (1.1.2) Requirement already satisfied: babel!=2.0,>=1.3 in /home/docs/checkouts/readthedocs.org/user_builds/icb-anndata/envs/latest/lib/python3.6/site-packages (from sphinx>=1.8->-r docs/requires.txt (line 2)) (2.7.0) Requirement already satisfied: snowballstemmer>=1.1 in /home/docs/checkouts/readthedocs.org/user_builds/icb-anndata/envs/latest/lib/python3.6/site-packages (from sphinx>=1.8->-r docs/requires.txt (line 2)) (1.9.0) Requirement already satisfied: alabaster<0.8,>=0.7 in /home/docs/checkouts/readthedocs.org/user_builds/icb-anndata/envs/latest/lib/python3.6/site-packages (from sphinx>=1.8->-r docs/requires.txt (line 2)) (0.7.12) Requirement already satisfied: docutils>=0.11 in /home/docs/checkouts/readthedocs.org/user_builds/icb-anndata/envs/latest/lib/python3.6/site-packages (from sphinx>=1.8->-r docs/requires.txt (line 2)) (0.14) Requirement already satisfied: setuptools in /home/docs/checkouts/readthedocs.org/user_builds/icb-anndata/envs/latest/lib/python3.6/site-packages (from sphinx>=1.8->-r docs/requires.txt (line 2)) (41.0.1) Requirement already satisfied: Jinja2>=2.3 in /home/docs/checkouts/readthedocs.org/user_builds/icb-anndata/envs/latest/lib/python3.6/site-packages (from sphinx>=1.8->-r docs/requires.txt (line 2)) (2.10.1) Requirement already satisfied: packaging in /home/docs/checkouts/readthedocs.org/user_builds/icb-anndata/envs/latest/lib/python3.6/site-packages (from sphinx>=1.8->-r docs/requires.txt (line 2)) (19.1) Requirement already satisfied: six>=1.5 in /home/docs/checkouts/readthedocs.org/user_builds/icb-anndata/envs/latest/lib/python3.6/site-packages (from sphinx>=1.8->-r docs/requires.txt (line 2)) (1.12.0) Collecting get_version (from scanpydoc>=0.3.2->-r docs/requires.txt (line 4)) Downloading https://files.pythonhosted.org/packages/2d/27/610ef458455cb1bcc4b454cebab43de3579e43d080af872727b9ac3146c8/get_version-2.0.6-py3-none-any.whl (43kB) Collecting python-dateutil>=2.6.1 (from pandas~=0.21->-r docs/requires.txt (line 6)) Downloading https://files.pythonhosted.org/packages/41/17/c62faccbfbd163c7f57f3844689e3a78bae1f403648a6afb1d0866d87fbb/python_dateutil-2.8.0-py2.py3-none-any.whl (226kB) Requirement already satisfied: pytz>=2017.2 in /home/docs/checkouts/readthedocs.org/user_builds/icb-anndata/envs/latest/lib/python3.6/site-packages (from pandas~=0.21->-r docs/requires.txt (line 6)) (2019.2) Collecting numpy>=1.13.3 (from pandas~=0.21->-r docs/requires.txt (line 6)) Downloading https://files.pythonhosted.org/packages/75/92/57179ed45307ec6179e344231c47da7f3f3da9e2eee5c8ab506bd279ce4e/numpy-1.17.1-cp36-cp36m-manylinux1_x86_64.whl (20.4MB) Requirement already satisfied: idna<2.9,>=2.5 in /home/docs/checkouts/readthedocs.org/user_builds/icb-anndata/envs/latest/lib/python3.6/site-packages (from requests>=2.0.0->sphinx>=1.8->-r docs/requires.txt (line 2)) (2.8) Requirement already satisfied: chardet<3.1.0,>=3.0.2 in /home/docs/checkouts/readthedocs.org/user_builds/icb-anndata/envs/latest/lib/python3.6/site-packages (from requests>=2.0.0->sphinx>=1.8->-r docs/requires.txt (line 2)) (3.0.4) Requirement already satisfied: urllib3!=1.25.0,!=1.25.1,<1.26,>=1.21.1 in /home/docs/checkouts/readthedocs.org/user_builds/icb-anndata/envs/latest/lib/python3.6/site-packages (from requests>=2.0.0->sphinx>=1.8->-r docs/requires.txt (line 2)) (1.25.3) Requirement already satisfied: certifi>=2017.4.17 in /home/docs/checkouts/readthedocs.org/user_builds/icb-anndata/envs/latest/lib/python3.6/site-packages (from requests>=2.0.0->sphinx>=1.8->-r docs/requires.txt (line 2)) (2019.6.16) Requirement already satisfied: MarkupSafe>=0.23 in /home/docs/checkouts/readthedocs.org/user_builds/icb-anndata/envs/latest/lib/python3.6/site-packages (from Jinja2>=2.3->sphinx>=1.8->-r docs/requires.txt (line 2)) (1.1.1) Requirement already satisfied: pyparsing>=2.0.2 in /home/docs/checkouts/readthedocs.org/user_builds/icb-anndata/envs/latest/lib/python3.6/site-packages (from packaging->sphinx>=1.8->-r docs/requires.txt (line 2)) (2.4.2) Requirement already satisfied: attrs in /home/docs/checkouts/readthedocs.org/user_builds/icb-anndata/envs/latest/lib/python3.6/site-packages (from packaging->sphinx>=1.8->-r docs/requires.txt (line 2)) (19.1.0) Collecting future-fstrings (from get_version->scanpydoc>=0.3.2->-r docs/requires.txt (line 4)) Downloading https://files.pythonhosted.org/packages/ab/6d/ea1d52e9038558dd37f5d30647eb9f07888c164960a5d4daa5f970c6da25/future_fstrings-1.2.0-py2.py3-none-any.whl ERROR: sphinx-autodoc-typehints 1.7.0 has requirement Sphinx>=2.1, but you'll have sphinx 1.8.5 which is incompatible. Installing collected packages: sphinx-autodoc-typehints, future-fstrings, get-version, scanpydoc, python-dateutil, numpy, pandas, scipy, h5py, natsort Successfully installed future-fstrings-1.2.0 get-version-2.0.6 h5py-2.9.0 natsort-6.0.0 numpy-1.17.1 pandas-0.25.1 python-dateutil-2.8.0 scanpydoc-0.3.8 scipy-1.3.1 sphinx-autodoc-typehints-1.7.0 [rtd-command-info] start-time: 2019-08-27T09:30:15.578382Z, end-time: 2019-08-27T09:30:15.924330Z, duration: 0, exit-code: 0 cat docs/conf.py import sys import logging from pathlib import Path from datetime import datetime HERE = Path(__file__).parent sys.path.insert(0, str(HERE.parent)) import anndata # noqa logger = logging.getLogger(__name__) for generated in HERE.glob('anndata.*.rst'): generated.unlink() # -- General configuration ------------------------------------------------ needs_sphinx = '1.7' # autosummary bugfix # General information project = 'anndata' author = anndata.__author__ copyright = f'{datetime.now():%Y}, {author}.' version = anndata.__version__.replace('.dirty', '') release = version # default settings templates_path = ['_templates'] source_suffix = '.rst' master_doc = 'index' default_role = 'literal' exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store'] pygments_style = 'sphinx' extensions = [ 'sphinx.ext.autodoc', 'sphinx.ext.intersphinx', 'sphinx.ext.doctest', 'sphinx.ext.coverage', 'sphinx.ext.mathjax', 'sphinx.ext.napoleon', 'sphinx.ext.autosummary', # 'plot_generator', # 'plot_directive', 'sphinx_autodoc_typehints', # needs to be after napoleon # 'ipython_directive', # 'ipython_console_highlighting', 'scanpydoc', ] # Generate the API documentation when building autosummary_generate = True autodoc_member_order = 'bysource' # autodoc_default_flags = ['members'] napoleon_google_docstring = False napoleon_numpy_docstring = True napoleon_include_init_with_doc = False napoleon_use_rtype = True # having a separate entry generally helps readability napoleon_use_param = True napoleon_custom_sections = [('Params', 'Parameters')] todo_include_todos = False nitpicky = True # Report broken links suppress_warnings = ['ref.citation'] def setup(app): # Don’t allow broken links # app.warningiserror = True app.add_stylesheet('css/custom.css') intersphinx_mapping = dict( h5py=('http://docs.h5py.org/en/latest/', None), loompy=('https://linnarssonlab.org/loompy/', None), numpy=('https://docs.scipy.org/doc/numpy/', None), pandas=('https://pandas.pydata.org/pandas-docs/stable/', None), python=('https://docs.python.org/3', None), scipy=('https://docs.scipy.org/doc/scipy/reference/', None), sklearn=('https://scikit-learn.org/stable/', None), ) # -- Options for HTML output ---------------------------------------------- html_theme = 'sphinx_rtd_theme' html_theme_options = dict( navigation_depth=2, ) html_context = dict( display_github=True, # Integrate GitHub github_user='theislab', # Username github_repo='anndata', # Repo name github_version='master', # Version conf_py_path='/docs/', # Path in the checkout to the docs root ) html_static_path = ['_static'] html_show_sphinx = False def setup(app): app.add_stylesheet('css/custom.css') # -- Options for other output formats ------------------------------------------ htmlhelp_basename = f'{project}doc' doc_title = f'{project} Documentation' latex_documents = [ (master_doc, f'{project}.tex', doc_title, author, 'manual'), ] man_pages = [ (master_doc, project, doc_title, [author], 1) ] texinfo_documents = [ (master_doc, project, doc_title, author, project, 'One line description of project.', 'Miscellaneous'), ] ########################################################################### # auto-created readthedocs.org specific configuration # ########################################################################### # # The following code was added during an automated build on readthedocs.org # It is auto created and injected for every build. The result is based on the # conf.py.tmpl file found in the readthedocs.org codebase: # https://github.com/rtfd/readthedocs.org/blob/master/readthedocs/doc_builder/templates/doc_builder/conf.py.tmpl # import importlib import sys import os.path from six import string_types from sphinx import version_info # Get suffix for proper linking to GitHub # This is deprecated in Sphinx 1.3+, # as each page can have its own suffix if globals().get('source_suffix', False): if isinstance(source_suffix, string_types): SUFFIX = source_suffix elif isinstance(source_suffix, (list, tuple)): # Sphinx >= 1.3 supports list/tuple to define multiple suffixes SUFFIX = source_suffix[0] elif isinstance(source_suffix, dict): # Sphinx >= 1.8 supports a mapping dictionary for multiple suffixes SUFFIX = list(source_suffix.keys())[0] # make a ``list()`` for py2/py3 compatibility else: # default to .rst SUFFIX = '.rst' else: SUFFIX = '.rst' # Add RTD Static Path. Add to the end because it overwrites previous files. if not 'html_static_path' in globals(): html_static_path = [] if os.path.exists('_static'): html_static_path.append('_static') # Add RTD Theme only if they aren't overriding it already using_rtd_theme = ( ( 'html_theme' in globals() and html_theme in ['default'] and # Allow people to bail with a hack of having an html_style 'html_style' not in globals() ) or 'html_theme' not in globals() ) if using_rtd_theme: theme = importlib.import_module('sphinx_rtd_theme') html_theme = 'sphinx_rtd_theme' html_style = None html_theme_options = {} if 'html_theme_path' in globals(): html_theme_path.append(theme.get_html_theme_path()) else: html_theme_path = [theme.get_html_theme_path()] if globals().get('websupport2_base_url', False): websupport2_base_url = 'https://readthedocs.com/websupport' websupport2_static_url = 'https://media.readthedocs.com/' #Add project information to the template context. context = { 'using_theme': using_rtd_theme, 'html_theme': html_theme, 'current_version': "latest", 'version_slug': "latest", 'MEDIA_URL': "https://media.readthedocs.com/media/", 'STATIC_URL': "https://media.readthedocs.com/", 'PRODUCTION_DOMAIN': "readthedocs.com", 'versions': [ ("latest", "/en/latest/"), ("stable", "/en/stable/"), ("doc-builds", "/en/doc-builds/"), ], 'downloads': [ ("html", "//readthedocs.com/projects/icb-anndata/downloads/htmlzip/latest/"), ], 'subprojects': [ ], 'slug': 'icb-anndata', 'name': u'anndata', 'rtd_language': u'en', 'programming_language': u'py', 'canonical_url': 'https://icb-anndata.readthedocs-hosted.com/en/stable/', 'analytics_code': 'None', 'single_version': False, 'conf_py_path': '/docs/', 'api_host': 'https://readthedocs.com', 'github_user': 'theislab', 'github_repo': 'anndata', 'github_version': 'master', 'display_github': True, 'bitbucket_user': 'None', 'bitbucket_repo': 'None', 'bitbucket_version': 'master', 'display_bitbucket': False, 'gitlab_user': 'None', 'gitlab_repo': 'None', 'gitlab_version': 'master', 'display_gitlab': False, 'READTHEDOCS': True, 'using_theme': (html_theme == "default"), 'new_theme': (html_theme == "sphinx_rtd_theme"), 'source_suffix': SUFFIX, 'ad_free': False, 'user_analytics_code': '', 'global_analytics_code': 'UA-17997319-2', 'commit': '926b82d9', } if 'html_context' in globals(): html_context.update(context) else: html_context = context # Add custom RTD extension if 'extensions' in globals(): # Insert at the beginning because it can interfere # with other extensions. # See https://github.com/rtfd/readthedocs.org/pull/4054 extensions.insert(0, "readthedocs_ext.readthedocs") else: extensions = ["readthedocs_ext.readthedocs"] # Add External version warning banner to the external version documentation if 'branch' == 'external': extensions.insert(1, "readthedocs_ext.external_version_warning") project_language = 'en' # User's Sphinx configurations language_user = globals().get('language', None) latex_engine_user = globals().get('latex_engine', None) latex_elements_user = globals().get('latex_elements', None) # Remove this once xindy gets installed in Docker image and XINDYOPS # env variable is supported # https://github.com/rtfd/readthedocs-docker-images/pull/98 latex_use_xindy = False chinese = any([ language_user in ('zh_CN', 'zh_TW'), project_language in ('zh_CN', 'zh_TW'), ]) japanese = any([ language_user == 'ja', project_language == 'ja', ]) if chinese: latex_engine = latex_engine_user or 'xelatex' latex_elements_rtd = { 'preamble': '\\usepackage[UTF8]{ctex}\n', } latex_elements = latex_elements_user or latex_elements_rtd elif japanese: latex_engine = latex_engine_user or 'platex' [rtd-command-info] start-time: 2019-08-27T09:30:16.016941Z, end-time: 2019-08-27T09:30:17.340610Z, duration: 1, exit-code: 2 python sphinx-build -T -b readthedocs -d _build/doctrees-readthedocs -D language=en . _build/html Running Sphinx v1.8.5 Traceback (most recent call last): File "/home/docs/checkouts/readthedocs.org/user_builds/icb-anndata/checkouts/latest/anndata/__init__.py", line 93, in from setuptools_scm import get_version ModuleNotFoundError: No module named 'setuptools_scm' During handling of the above exception, another exception occurred: Traceback (most recent call last): File "/home/docs/checkouts/readthedocs.org/user_builds/icb-anndata/checkouts/latest/anndata/compat.py", line 6, in version from importlib.metadata import version ModuleNotFoundError: No module named 'importlib.metadata' During handling of the above exception, another exception occurred: Traceback (most recent call last): File "/home/docs/checkouts/readthedocs.org/user_builds/icb-anndata/envs/latest/lib/python3.6/site-packages/sphinx/config.py", line 368, in eval_config_file execfile_(filename, namespace) File "/home/docs/checkouts/readthedocs.org/user_builds/icb-anndata/envs/latest/lib/python3.6/site-packages/sphinx/util/pycompat.py", line 150, in execfile_ exec_(code, _globals) File "/home/docs/checkouts/readthedocs.org/user_builds/icb-anndata/checkouts/latest/docs/conf.py", line 8, in import anndata # noqa File "/home/docs/checkouts/readthedocs.org/user_builds/icb-anndata/checkouts/latest/anndata/__init__.py", line 98, in __version__ = version(__name__) File "/home/docs/checkouts/readthedocs.org/user_builds/icb-anndata/checkouts/latest/anndata/compat.py", line 8, in version from importlib_metadata import version ModuleNotFoundError: No module named 'importlib_metadata' During handling of the above exception, another exception occurred: Traceback (most recent call last): File "/home/docs/checkouts/readthedocs.org/user_builds/icb-anndata/envs/latest/lib/python3.6/site-packages/sphinx/cmd/build.py", line 303, in build_main args.tags, args.verbosity, args.jobs, args.keep_going) File "/home/docs/checkouts/readthedocs.org/user_builds/icb-anndata/envs/latest/lib/python3.6/site-packages/sphinx/application.py", line 201, in __init__ self.config = Config.read(self.confdir, confoverrides or {}, self.tags) File "/home/docs/checkouts/readthedocs.org/user_builds/icb-anndata/envs/latest/lib/python3.6/site-packages/sphinx/config.py", line 203, in read namespace = eval_config_file(filename, tags) File "/home/docs/checkouts/readthedocs.org/user_builds/icb-anndata/envs/latest/lib/python3.6/site-packages/sphinx/config.py", line 380, in eval_config_file raise ConfigError(msg % traceback.format_exc()) sphinx.errors.ConfigError: There is a programmable error in your configuration file: Traceback (most recent call last): File "/home/docs/checkouts/readthedocs.org/user_builds/icb-anndata/checkouts/latest/anndata/__init__.py", line 93, in from setuptools_scm import get_version ModuleNotFoundError: No module named 'setuptools_scm' During handling of the above exception, another exception occurred: Traceback (most recent call last): File "/home/docs/checkouts/readthedocs.org/user_builds/icb-anndata/checkouts/latest/anndata/compat.py", line 6, in version from importlib.metadata import version ModuleNotFoundError: No module named 'importlib.metadata' During handling of the above exception, another exception occurred: Traceback (most recent call last): File "/home/docs/checkouts/readthedocs.org/user_builds/icb-anndata/envs/latest/lib/python3.6/site-packages/sphinx/config.py", line 368, in eval_config_file execfile_(filename, namespace) File "/home/docs/checkouts/readthedocs.org/user_builds/icb-anndata/envs/latest/lib/python3.6/site-packages/sphinx/util/pycompat.py", line 150, in execfile_ exec_(code, _globals) File "/home/docs/checkouts/readthedocs.org/user_builds/icb-anndata/checkouts/latest/docs/conf.py", line 8, in import anndata # noqa File "/home/docs/checkouts/readthedocs.org/user_builds/icb-anndata/checkouts/latest/anndata/__init__.py", line 98, in __version__ = version(__name__) File "/home/docs/checkouts/readthedocs.org/user_builds/icb-anndata/checkouts/latest/anndata/compat.py", line 8, in version from importlib_metadata import version ModuleNotFoundError: No module named 'importlib_metadata' Configuration error: There is a programmable error in your configuration file: Traceback (most recent call last): File "/home/docs/checkouts/readthedocs.org/user_builds/icb-anndata/checkouts/latest/anndata/__init__.py", line 93, in from setuptools_scm import get_version ModuleNotFoundError: No module named 'setuptools_scm' During handling of the above exception, another exception occurred: Traceback (most recent call last): File "/home/docs/checkouts/readthedocs.org/user_builds/icb-anndata/checkouts/latest/anndata/compat.py", line 6, in version from importlib.metadata import version ModuleNotFoundError: No module named 'importlib.metadata' During handling of the above exception, another exception occurred: Traceback (most recent call last): File "/home/docs/checkouts/readthedocs.org/user_builds/icb-anndata/envs/latest/lib/python3.6/site-packages/sphinx/config.py", line 368, in eval_config_file execfile_(filename, namespace) File "/home/docs/checkouts/readthedocs.org/user_builds/icb-anndata/envs/latest/lib/python3.6/site-packages/sphinx/util/pycompat.py", line 150, in execfile_ exec_(code, _globals) File "/home/docs/checkouts/readthedocs.org/user_builds/icb-anndata/checkouts/latest/docs/conf.py", line 8, in import anndata # noqa File "/home/docs/checkouts/readthedocs.org/user_builds/icb-anndata/checkouts/latest/anndata/__init__.py", line 98, in __version__ = version(__name__) File "/home/docs/checkouts/readthedocs.org/user_builds/icb-anndata/checkouts/latest/anndata/compat.py", line 8, in version from importlib_metadata import version ModuleNotFoundError: No module named 'importlib_metadata'