Read the Docs build information Build id: 300373 Project: icb-scanpy Version: latest Commit: f1393ffbbce23c5e04adc3a2154453c281c17775 Date: 2020-03-11T06:38:10.146377Z State: finished Success: False [rtd-command-info] start-time: 2020-03-11T06:38:12.959147Z, end-time: 2020-03-11T06:38:15.455797Z, duration: 2, exit-code: 0 git clone --no-single-branch --depth 50 https://github.com/theislab/scanpy.git . Cloning into '.'... [rtd-command-info] start-time: 2020-03-11T06:38:15.861969Z, end-time: 2020-03-11T06:38:16.271972Z, 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 f1393ff Fix #1082 [rtd-command-info] start-time: 2020-03-11T06:38:16.426752Z, end-time: 2020-03-11T06:38:16.734310Z, duration: 0, exit-code: 0 git clean -d -f -f [rtd-command-info] start-time: 2020-03-11T06:38:18.339166Z, end-time: 2020-03-11T06:38:23.168533Z, duration: 4, exit-code: 0 python3.6 -mvirtualenv Using base prefix '/home/docs/.pyenv/versions/3.6.8' New python executable in /home/docs/checkouts/readthedocs.org/user_builds/icb-scanpy/envs/latest/bin/python3.6 Also creating executable in /home/docs/checkouts/readthedocs.org/user_builds/icb-scanpy/envs/latest/bin/python Installing setuptools, pip, wheel... done. [rtd-command-info] start-time: 2020-03-11T06:38:23.335475Z, end-time: 2020-03-11T06:38:25.419289Z, duration: 2, exit-code: 0 python -m pip install --upgrade --cache-dir /home/docs/checkouts/readthedocs.org/user_builds/icb-scanpy/.cache/pip pip Requirement already up-to-date: pip in /home/docs/checkouts/readthedocs.org/user_builds/icb-scanpy/envs/latest/lib/python3.6/site-packages (20.0.2) [rtd-command-info] start-time: 2020-03-11T06:38:25.590233Z, end-time: 2020-03-11T06:38:38.744815Z, duration: 13, exit-code: 0 python -m pip install --upgrade --cache-dir /home/docs/checkouts/readthedocs.org/user_builds/icb-scanpy/.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 Pygments-2.3.1-py2.py3-none-any.whl (849 kB) Collecting setuptools==41.0.1 Downloading setuptools-41.0.1-py2.py3-none-any.whl (575 kB) Collecting docutils==0.14 Downloading docutils-0.14-py3-none-any.whl (543 kB) Collecting mock==1.0.1 Downloading mock-1.0.1.tar.gz (818 kB) Collecting pillow==5.4.1 Downloading Pillow-5.4.1-cp36-cp36m-manylinux1_x86_64.whl (2.0 MB) Collecting alabaster!=0.7.5,<0.8,>=0.7 Downloading alabaster-0.7.12-py2.py3-none-any.whl (14 kB) Collecting commonmark==0.8.1 Downloading commonmark-0.8.1-py2.py3-none-any.whl (47 kB) Collecting recommonmark==0.5.0 Downloading recommonmark-0.5.0-py2.py3-none-any.whl (9.8 kB) Collecting sphinx<2 Downloading Sphinx-1.8.5-py2.py3-none-any.whl (3.1 MB) Collecting sphinx-rtd-theme<0.5 Downloading sphinx_rtd_theme-0.4.3-py2.py3-none-any.whl (6.4 MB) Collecting readthedocs-sphinx-ext<1.1 Downloading readthedocs_sphinx_ext-1.0.1-py2.py3-none-any.whl (14 kB) Collecting future Downloading future-0.18.2.tar.gz (829 kB) Collecting babel!=2.0,>=1.3 Downloading Babel-2.8.0-py2.py3-none-any.whl (8.6 MB) Collecting sphinxcontrib-websupport Downloading sphinxcontrib_websupport-1.2.0-py2.py3-none-any.whl (39 kB) Collecting packaging Downloading packaging-20.3-py2.py3-none-any.whl (37 kB) Collecting six>=1.5 Downloading six-1.14.0-py2.py3-none-any.whl (10 kB) Collecting Jinja2>=2.3 Downloading Jinja2-2.11.1-py2.py3-none-any.whl (126 kB) Collecting snowballstemmer>=1.1 Downloading snowballstemmer-2.0.0-py2.py3-none-any.whl (97 kB) Collecting imagesize Downloading imagesize-1.2.0-py2.py3-none-any.whl (4.8 kB) Collecting requests>=2.0.0 Downloading requests-2.23.0-py2.py3-none-any.whl (58 kB) Collecting pytz>=2015.7 Downloading pytz-2019.3-py2.py3-none-any.whl (509 kB) Collecting pyparsing>=2.0.2 Downloading pyparsing-2.4.6-py2.py3-none-any.whl (67 kB) Collecting MarkupSafe>=0.23 Downloading MarkupSafe-1.1.1-cp36-cp36m-manylinux1_x86_64.whl (27 kB) Collecting urllib3!=1.25.0,!=1.25.1,<1.26,>=1.21.1 Downloading urllib3-1.25.8-py2.py3-none-any.whl (125 kB) Collecting chardet<4,>=3.0.2 Downloading chardet-3.0.4-py2.py3-none-any.whl (133 kB) Collecting idna<3,>=2.5 Downloading idna-2.9-py2.py3-none-any.whl (58 kB) Collecting certifi>=2017.4.17 Downloading certifi-2019.11.28-py2.py3-none-any.whl (156 kB) Building wheels for collected packages: mock, future 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-py3-none-any.whl size=23754 sha256=a9304595d0adee7367bff2e7ec4df819069d9609c3b7e1d6253a857e643569a9 Stored in directory: /home/docs/checkouts/readthedocs.org/user_builds/icb-scanpy/.cache/pip/wheels/15/fd/39/f238f155700d6d5e6231e82ae3ccf3aa7490a1b17d2073251b Building wheel for future (setup.py): started Building wheel for future (setup.py): finished with status 'done' Created wheel for future: filename=future-0.18.2-py3-none-any.whl size=491058 sha256=69f883b0380e2b491a88338d3625bdda70a051b7aeac7918ca243a7c3086f2ee Stored in directory: /home/docs/checkouts/readthedocs.org/user_builds/icb-scanpy/.cache/pip/wheels/6e/9c/ed/4499c9865ac1002697793e0ae05ba6be33553d098f3347fb94 Successfully built mock future Installing collected packages: Pygments, setuptools, docutils, mock, pillow, alabaster, future, commonmark, pytz, babel, sphinxcontrib-websupport, pyparsing, six, packaging, MarkupSafe, Jinja2, snowballstemmer, imagesize, urllib3, chardet, idna, certifi, requests, sphinx, recommonmark, sphinx-rtd-theme, readthedocs-sphinx-ext Attempting uninstall: setuptools Found existing installation: setuptools 46.0.0 Uninstalling setuptools-46.0.0: Successfully uninstalled setuptools-46.0.0 Successfully installed Jinja2-2.11.1 MarkupSafe-1.1.1 Pygments-2.3.1 alabaster-0.7.12 babel-2.8.0 certifi-2019.11.28 chardet-3.0.4 commonmark-0.8.1 docutils-0.14 future-0.18.2 idna-2.9 imagesize-1.2.0 mock-1.0.1 packaging-20.3 pillow-5.4.1 pyparsing-2.4.6 pytz-2019.3 readthedocs-sphinx-ext-1.0.1 recommonmark-0.5.0 requests-2.23.0 setuptools-41.0.1 six-1.14.0 snowballstemmer-2.0.0 sphinx-1.8.5 sphinx-rtd-theme-0.4.3 sphinxcontrib-websupport-1.2.0 urllib3-1.25.8 [rtd-command-info] start-time: 2020-03-11T06:38:38.902104Z, end-time: 2020-03-11T06:39:17.437930Z, duration: 38, exit-code: 0 python -m pip install --exists-action=w --cache-dir /home/docs/checkouts/readthedocs.org/user_builds/icb-scanpy/.cache/pip -r docs/requirements.txt Collecting anndata>=0.7 Downloading anndata-0.7.1-py3-none-any.whl (97 kB) Collecting matplotlib>=3.1 Downloading matplotlib-3.2.0-cp36-cp36m-manylinux1_x86_64.whl (12.4 MB) Collecting pandas>=0.21 Downloading pandas-1.0.1-cp36-cp36m-manylinux1_x86_64.whl (10.1 MB) Collecting scipy>=1.3 Downloading scipy-1.4.1-cp36-cp36m-manylinux1_x86_64.whl (26.1 MB) Collecting seaborn Downloading seaborn-0.10.0-py3-none-any.whl (215 kB) Collecting h5py>=2.10.0 Downloading h5py-2.10.0-cp36-cp36m-manylinux1_x86_64.whl (2.9 MB) Collecting tables Downloading tables-3.6.1-cp36-cp36m-manylinux1_x86_64.whl (4.3 MB) Collecting tqdm Downloading tqdm-4.43.0-py2.py3-none-any.whl (59 kB) Collecting importlib_metadata>=0.7 Downloading importlib_metadata-1.5.0-py2.py3-none-any.whl (30 kB) Collecting scikit-learn>=0.21.2 Downloading scikit_learn-0.22.2.post1-cp36-cp36m-manylinux1_x86_64.whl (7.1 MB) Collecting statsmodels>=0.10.0rc2 Downloading statsmodels-0.11.1-cp36-cp36m-manylinux1_x86_64.whl (8.7 MB) Collecting patsy Downloading patsy-0.5.1-py2.py3-none-any.whl (231 kB) Collecting networkx Downloading networkx-2.4-py3-none-any.whl (1.6 MB) Collecting natsort Downloading natsort-7.0.1-py3-none-any.whl (33 kB) Collecting joblib Downloading joblib-0.14.1-py2.py3-none-any.whl (294 kB) Collecting numba>=0.41.0 Downloading numba-0.48.0-cp36-cp36m-manylinux1_x86_64.whl (2.5 MB) Collecting umap-learn>=0.3.10 Downloading umap-learn-0.3.10.tar.gz (40 kB) Collecting legacy-api-wrap Downloading legacy_api_wrap-1.2-py3-none-any.whl (37 kB) Collecting setuptools_scm Downloading setuptools_scm-3.5.0-py2.py3-none-any.whl (26 kB) Requirement already satisfied: packaging in /home/docs/checkouts/readthedocs.org/user_builds/icb-scanpy/envs/latest/lib/python3.6/site-packages (from -r docs/../requirements.txt (line 22)) (20.3) Requirement already satisfied: sphinx_rtd_theme>=0.3.1 in /home/docs/checkouts/readthedocs.org/user_builds/icb-scanpy/envs/latest/lib/python3.6/site-packages (from -r docs/requirements.txt (line 2)) (0.4.3) Collecting sphinx>=2.0.1 Downloading Sphinx-2.4.4-py3-none-any.whl (2.7 MB) Collecting sphinx-autodoc-typehints Downloading sphinx_autodoc_typehints-1.10.3-py3-none-any.whl (8.4 kB) Collecting scanpydoc>=0.4.5 Downloading scanpydoc-0.4.5-py3-none-any.whl (23 kB) Collecting typing_extensions Downloading typing_extensions-3.7.4.1-py3-none-any.whl (20 kB) Collecting numpy~=1.14 Downloading numpy-1.18.1-cp36-cp36m-manylinux1_x86_64.whl (20.1 MB) Requirement already satisfied: pyparsing!=2.0.4,!=2.1.2,!=2.1.6,>=2.0.1 in /home/docs/checkouts/readthedocs.org/user_builds/icb-scanpy/envs/latest/lib/python3.6/site-packages (from matplotlib>=3.1->-r docs/../requirements.txt (line 4)) (2.4.6) Collecting python-dateutil>=2.1 Downloading python_dateutil-2.8.1-py2.py3-none-any.whl (227 kB) Collecting cycler>=0.10 Downloading cycler-0.10.0-py2.py3-none-any.whl (6.5 kB) Collecting kiwisolver>=1.0.1 Downloading kiwisolver-1.1.0-cp36-cp36m-manylinux1_x86_64.whl (90 kB) Requirement already satisfied: pytz>=2017.2 in /home/docs/checkouts/readthedocs.org/user_builds/icb-scanpy/envs/latest/lib/python3.6/site-packages (from pandas>=0.21->-r docs/../requirements.txt (line 5)) (2019.3) Requirement already satisfied: six in /home/docs/checkouts/readthedocs.org/user_builds/icb-scanpy/envs/latest/lib/python3.6/site-packages (from h5py>=2.10.0->-r docs/../requirements.txt (line 8)) (1.14.0) Collecting numexpr>=2.6.2 Downloading numexpr-2.7.1-cp36-cp36m-manylinux1_x86_64.whl (162 kB) Collecting zipp>=0.5 Downloading zipp-3.1.0-py3-none-any.whl (4.9 kB) Collecting decorator>=4.3.0 Downloading decorator-4.4.2-py2.py3-none-any.whl (9.2 kB) Requirement already satisfied: setuptools in /home/docs/checkouts/readthedocs.org/user_builds/icb-scanpy/envs/latest/lib/python3.6/site-packages (from numba>=0.41.0->-r docs/../requirements.txt (line 18)) (41.0.1) Collecting llvmlite<0.32.0,>=0.31.0dev0 Downloading llvmlite-0.31.0-cp36-cp36m-manylinux1_x86_64.whl (20.2 MB) Collecting get-version>=2.0.4 Downloading get_version-2.1-py3-none-any.whl (43 kB) Requirement already satisfied: requests>=2.5.0 in /home/docs/checkouts/readthedocs.org/user_builds/icb-scanpy/envs/latest/lib/python3.6/site-packages (from sphinx>=2.0.1->-r docs/requirements.txt (line 3)) (2.23.0) Requirement already satisfied: docutils>=0.12 in /home/docs/checkouts/readthedocs.org/user_builds/icb-scanpy/envs/latest/lib/python3.6/site-packages (from sphinx>=2.0.1->-r docs/requirements.txt (line 3)) (0.14) Collecting sphinxcontrib-htmlhelp Downloading sphinxcontrib_htmlhelp-1.0.3-py2.py3-none-any.whl (96 kB) Collecting sphinxcontrib-serializinghtml Downloading sphinxcontrib_serializinghtml-1.1.4-py2.py3-none-any.whl (89 kB) Requirement already satisfied: snowballstemmer>=1.1 in /home/docs/checkouts/readthedocs.org/user_builds/icb-scanpy/envs/latest/lib/python3.6/site-packages (from sphinx>=2.0.1->-r docs/requirements.txt (line 3)) (2.0.0) Collecting sphinxcontrib-jsmath Downloading sphinxcontrib_jsmath-1.0.1-py2.py3-none-any.whl (5.1 kB) Collecting sphinxcontrib-applehelp Downloading sphinxcontrib_applehelp-1.0.2-py2.py3-none-any.whl (121 kB) Requirement already satisfied: alabaster<0.8,>=0.7 in /home/docs/checkouts/readthedocs.org/user_builds/icb-scanpy/envs/latest/lib/python3.6/site-packages (from sphinx>=2.0.1->-r docs/requirements.txt (line 3)) (0.7.12) Requirement already satisfied: babel!=2.0,>=1.3 in /home/docs/checkouts/readthedocs.org/user_builds/icb-scanpy/envs/latest/lib/python3.6/site-packages (from sphinx>=2.0.1->-r docs/requirements.txt (line 3)) (2.8.0) Requirement already satisfied: Pygments>=2.0 in /home/docs/checkouts/readthedocs.org/user_builds/icb-scanpy/envs/latest/lib/python3.6/site-packages (from sphinx>=2.0.1->-r docs/requirements.txt (line 3)) (2.3.1) Requirement already satisfied: imagesize in /home/docs/checkouts/readthedocs.org/user_builds/icb-scanpy/envs/latest/lib/python3.6/site-packages (from sphinx>=2.0.1->-r docs/requirements.txt (line 3)) (1.2.0) Collecting sphinxcontrib-qthelp Downloading sphinxcontrib_qthelp-1.0.3-py2.py3-none-any.whl (90 kB) Requirement already satisfied: Jinja2>=2.3 in /home/docs/checkouts/readthedocs.org/user_builds/icb-scanpy/envs/latest/lib/python3.6/site-packages (from sphinx>=2.0.1->-r docs/requirements.txt (line 3)) (2.11.1) Collecting sphinxcontrib-devhelp Downloading sphinxcontrib_devhelp-1.0.2-py2.py3-none-any.whl (84 kB) Requirement already satisfied: certifi>=2017.4.17 in /home/docs/checkouts/readthedocs.org/user_builds/icb-scanpy/envs/latest/lib/python3.6/site-packages (from requests>=2.5.0->sphinx>=2.0.1->-r docs/requirements.txt (line 3)) (2019.11.28) Requirement already satisfied: idna<3,>=2.5 in /home/docs/checkouts/readthedocs.org/user_builds/icb-scanpy/envs/latest/lib/python3.6/site-packages (from requests>=2.5.0->sphinx>=2.0.1->-r docs/requirements.txt (line 3)) (2.9) Requirement already satisfied: urllib3!=1.25.0,!=1.25.1,<1.26,>=1.21.1 in /home/docs/checkouts/readthedocs.org/user_builds/icb-scanpy/envs/latest/lib/python3.6/site-packages (from requests>=2.5.0->sphinx>=2.0.1->-r docs/requirements.txt (line 3)) (1.25.8) Requirement already satisfied: chardet<4,>=3.0.2 in /home/docs/checkouts/readthedocs.org/user_builds/icb-scanpy/envs/latest/lib/python3.6/site-packages (from requests>=2.5.0->sphinx>=2.0.1->-r docs/requirements.txt (line 3)) (3.0.4) Requirement already satisfied: MarkupSafe>=0.23 in /home/docs/checkouts/readthedocs.org/user_builds/icb-scanpy/envs/latest/lib/python3.6/site-packages (from Jinja2>=2.3->sphinx>=2.0.1->-r docs/requirements.txt (line 3)) (1.1.1) Building wheels for collected packages: umap-learn Building wheel for umap-learn (setup.py): started Building wheel for umap-learn (setup.py): finished with status 'done' Created wheel for umap-learn: filename=umap_learn-0.3.10-py3-none-any.whl size=38881 sha256=0a8e17860c674358e46ccbb9035c9c4d2f5e255757377d3ebdb2ec27b88ae484 Stored in directory: /home/docs/checkouts/readthedocs.org/user_builds/icb-scanpy/.cache/pip/wheels/1b/69/69/91e19c0578b1740a6358f5db2c2dcc5af5b04360c3c9066b26 Successfully built umap-learn Installing collected packages: numpy, scipy, python-dateutil, pandas, zipp, importlib-metadata, h5py, natsort, anndata, cycler, kiwisolver, matplotlib, seaborn, numexpr, tables, tqdm, joblib, scikit-learn, patsy, statsmodels, decorator, networkx, llvmlite, numba, umap-learn, get-version, legacy-api-wrap, setuptools-scm, sphinxcontrib-htmlhelp, sphinxcontrib-serializinghtml, sphinxcontrib-jsmath, sphinxcontrib-applehelp, sphinxcontrib-qthelp, sphinxcontrib-devhelp, sphinx, sphinx-autodoc-typehints, scanpydoc, typing-extensions Attempting uninstall: sphinx Found existing installation: Sphinx 1.8.5 Uninstalling Sphinx-1.8.5: Successfully uninstalled Sphinx-1.8.5 Successfully installed anndata-0.7.1 cycler-0.10.0 decorator-4.4.2 get-version-2.1 h5py-2.10.0 importlib-metadata-1.5.0 joblib-0.14.1 kiwisolver-1.1.0 legacy-api-wrap-1.2 llvmlite-0.31.0 matplotlib-3.2.0 natsort-7.0.1 networkx-2.4 numba-0.48.0 numexpr-2.7.1 numpy-1.18.1 pandas-1.0.1 patsy-0.5.1 python-dateutil-2.8.1 scanpydoc-0.4.5 scikit-learn-0.22.2.post1 scipy-1.4.1 seaborn-0.10.0 setuptools-scm-3.5.0 sphinx-2.4.4 sphinx-autodoc-typehints-1.10.3 sphinxcontrib-applehelp-1.0.2 sphinxcontrib-devhelp-1.0.2 sphinxcontrib-htmlhelp-1.0.3 sphinxcontrib-jsmath-1.0.1 sphinxcontrib-qthelp-1.0.3 sphinxcontrib-serializinghtml-1.1.4 statsmodels-0.11.1 tables-3.6.1 tqdm-4.43.0 typing-extensions-3.7.4.1 umap-learn-0.3.10 zipp-3.1.0 [rtd-command-info] start-time: 2020-03-11T06:39:18.831017Z, end-time: 2020-03-11T06:39:19.143132Z, duration: 0, exit-code: 0 cat docs/conf.py import os import sys import warnings from pathlib import Path from datetime import datetime import matplotlib # noqa # Don’t use tkinter agg when importing scanpy → … → matplotlib matplotlib.use('agg') HERE = Path(__file__).parent sys.path[:0] = [str(HERE.parent), str(HERE / 'extensions')] import scanpy # noqa on_rtd = os.environ.get('READTHEDOCS') == 'True' # -- General configuration ------------------------------------------------ nitpicky = True # Warn about broken links. This is here for a reason: Do not change. needs_sphinx = '2.0' # Nicer param docs suppress_warnings = ['ref.citation'] # General information project = 'Scanpy' author = scanpy.__author__ copyright = f'{datetime.now():%Y}, {author}.' version = scanpy.__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', *[p.stem for p in (HERE / 'extensions').glob('*.py')], ] # 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 api_dir = HERE / 'api' # function_images scanpy_tutorials_url = 'https://scanpy-tutorials.readthedocs.io/en/latest/' intersphinx_mapping = dict( anndata=('https://anndata.readthedocs.io/en/stable/', None), bbknn=('https://bbknn.readthedocs.io/en/latest/', None), cycler=('https://matplotlib.org/cycler/', None), h5py=('http://docs.h5py.org/en/stable/', None), ipython=('https://ipython.readthedocs.io/en/stable/', None), leidenalg=('https://leidenalg.readthedocs.io/en/latest/', None), louvain=('https://louvain-igraph.readthedocs.io/en/latest/', None), matplotlib=('https://matplotlib.org/', None), networkx=('https://networkx.github.io/documentation/networkx-1.10/', 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), scvelo=('https://scvelo.readthedocs.io/', None), seaborn=('https://seaborn.pydata.org/', None), sklearn=('https://scikit-learn.org/stable/', None), scanpy_tutorials=(scanpy_tutorials_url, None), ) # -- Options for HTML output ---------------------------------------------- html_theme = 'sphinx_rtd_theme' html_theme_options = dict(navigation_depth=4, logo_only=True) # Only show the logo html_context = dict( display_github=True, # Integrate GitHub github_user='theislab', # Username github_repo='scanpy', # 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 html_logo = '_static/img/Scanpy_Logo_BrightFG.svg' def setup(app): app.warningiserror = on_rtd 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', ) ] # -- Suppress link warnings ---------------------------------------------------- qualname_overrides = { "sklearn.neighbors.dist_metrics.DistanceMetric": "sklearn.neighbors.DistanceMetric", # If the docs are built with an old version of numpy, this will make it work: "numpy.random.RandomState": "numpy.random.mtrand.RandomState", } nitpick_ignore = [ # Will probably be documented ('py:class', 'scanpy._settings.Verbosity'), # Currently undocumented: https://github.com/mwaskom/seaborn/issues/1810 ('py:class', 'seaborn.ClusterGrid'), # Won’t be documented ('py:class', 'scanpy._utils.Empty'), ] ########################################################################### # 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/"), ("1.4.4.post1", "/en/1.4.4.post1/"), ("1.1", "/en/1.1/"), ], 'downloads': [ ("html", "//icb-scanpy.readthedocs-hosted.com/_/downloads/en/latest/htmlzip/"), ], 'subprojects': [ ], 'slug': 'icb-scanpy', 'name': u'scanpy', 'rtd_language': u'en', 'programming_language': u'py', 'canonical_url': 'https://icb-scanpy.readthedocs-hosted.com/en/stable/', 'analytics_code': 'None', 'single_version': False, 'conf_py_path': '/docs/', 'api_host': 'https://readthedocs.com', 'proxied_api_host': '/_', 'github_user': 'theislab', 'github_repo': 'scanpy', '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': 'f1393ffb', } 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: 2020-03-11T06:39:19.509638Z, end-time: 2020-03-11T06:39:30.106961Z, duration: 10, exit-code: 2 python sphinx-build -T -E -b readthedocs -d _build/doctrees-readthedocs -D language=en . _build/html Running Sphinx v2.4.4 loading translations [en]... done making output directory... done loading intersphinx inventory from https://anndata.readthedocs.io/en/stable/objects.inv... loading intersphinx inventory from https://bbknn.readthedocs.io/en/latest/objects.inv... loading intersphinx inventory from https://matplotlib.org/cycler/objects.inv... loading intersphinx inventory from http://docs.h5py.org/en/stable/objects.inv... loading intersphinx inventory from https://ipython.readthedocs.io/en/stable/objects.inv... loading intersphinx inventory from https://leidenalg.readthedocs.io/en/latest/objects.inv... loading intersphinx inventory from https://louvain-igraph.readthedocs.io/en/latest/objects.inv... loading intersphinx inventory from https://matplotlib.org/objects.inv... loading intersphinx inventory from https://networkx.github.io/documentation/networkx-1.10/objects.inv... loading intersphinx inventory from https://docs.scipy.org/doc/numpy/objects.inv... loading intersphinx inventory from https://pandas.pydata.org/pandas-docs/stable/objects.inv... loading intersphinx inventory from https://docs.python.org/3/objects.inv... loading intersphinx inventory from https://docs.scipy.org/doc/scipy/reference/objects.inv... loading intersphinx inventory from https://scvelo.readthedocs.io/objects.inv... loading intersphinx inventory from https://seaborn.pydata.org/objects.inv... loading intersphinx inventory from https://scikit-learn.org/stable/objects.inv... loading intersphinx inventory from https://scanpy-tutorials.readthedocs.io/en/latest/objects.inv... [autosummary] generating autosummary for: _key_contributors.rst, _links.rst, api/index.rst, api/plotting.rst, api/scanpy.external.rst, api/scanpy.plotting.rst, basic_usage.rst, ecosystem.rst, external/index.rst, index.rst, installation.rst, references.rst, release-latest.rst, release-notes.rst, tutorials.rst, usage-principles.rst /home/docs/checkouts/readthedocs.org/user_builds/icb-scanpy/envs/latest/lib/python3.6/site-packages/anndata/_core/anndata.py:21: FutureWarning: pandas.core.index is deprecated and will be removed in a future version. The public classes are available in the top-level namespace. from pandas.core.index import RangeIndex /home/docs/checkouts/readthedocs.org/user_builds/icb-scanpy/envs/latest/lib/python3.6/site-packages/setuptools_scm/git.py:68: UserWarning: "/home/docs/checkouts/readthedocs.org/user_builds/icb-scanpy/checkouts/latest" is shallow and may cause errors warnings.warn('"{}" is shallow and may cause errors'.format(wd.path)) Traceback (most recent call last): File "/home/docs/checkouts/readthedocs.org/user_builds/icb-scanpy/envs/latest/lib/python3.6/site-packages/sphinx/ext/autosummary/generate.py", line 272, in generate_autosummary_docs name, obj, parent, mod_name = import_by_name(name) File "/home/docs/checkouts/readthedocs.org/user_builds/icb-scanpy/envs/latest/lib/python3.6/site-packages/sphinx/ext/autosummary/__init__.py", line 599, in import_by_name raise ImportError('no module named %s' % ' or '.join(tried)) ImportError: no module named scanpy.external.pl.wishbone During handling of the above exception, another exception occurred: Traceback (most recent call last): File "/home/docs/checkouts/readthedocs.org/user_builds/icb-scanpy/envs/latest/lib/python3.6/site-packages/sphinx/cmd/build.py", line 275, in build_main args.tags, args.verbosity, args.jobs, args.keep_going) File "/home/docs/checkouts/readthedocs.org/user_builds/icb-scanpy/envs/latest/lib/python3.6/site-packages/sphinx/application.py", line 278, in __init__ self._init_builder() File "/home/docs/checkouts/readthedocs.org/user_builds/icb-scanpy/envs/latest/lib/python3.6/site-packages/sphinx/application.py", line 334, in _init_builder self.events.emit('builder-inited') File "/home/docs/checkouts/readthedocs.org/user_builds/icb-scanpy/envs/latest/lib/python3.6/site-packages/sphinx/events.py", line 99, in emit results.append(callback(self.app, *args)) File "/home/docs/checkouts/readthedocs.org/user_builds/icb-scanpy/envs/latest/lib/python3.6/site-packages/sphinx/ext/autosummary/__init__.py", line 748, in process_generate_options app=app, imported_members=imported_members) File "/home/docs/checkouts/readthedocs.org/user_builds/icb-scanpy/envs/latest/lib/python3.6/site-packages/sphinx/ext/autosummary/generate.py", line 274, in generate_autosummary_docs _warn('[autosummary] failed to import %r: %s' % (name, e)) File "/home/docs/.pyenv/versions/3.6.8/lib/python3.6/logging/__init__.py", line 1642, in warning self.log(WARNING, msg, *args, **kwargs) File "/home/docs/checkouts/readthedocs.org/user_builds/icb-scanpy/envs/latest/lib/python3.6/site-packages/sphinx/util/logging.py", line 124, in log super().log(level, msg, *args, **kwargs) File "/home/docs/.pyenv/versions/3.6.8/lib/python3.6/logging/__init__.py", line 1674, in log self.logger.log(level, msg, *args, **kwargs) File "/home/docs/.pyenv/versions/3.6.8/lib/python3.6/logging/__init__.py", line 1374, in log self._log(level, msg, args, **kwargs) File "/home/docs/.pyenv/versions/3.6.8/lib/python3.6/logging/__init__.py", line 1444, in _log self.handle(record) File "/home/docs/.pyenv/versions/3.6.8/lib/python3.6/logging/__init__.py", line 1454, in handle self.callHandlers(record) File "/home/docs/.pyenv/versions/3.6.8/lib/python3.6/logging/__init__.py", line 1516, in callHandlers hdlr.handle(record) File "/home/docs/.pyenv/versions/3.6.8/lib/python3.6/logging/__init__.py", line 861, in handle rv = self.filter(record) File "/home/docs/.pyenv/versions/3.6.8/lib/python3.6/logging/__init__.py", line 720, in filter result = f.filter(record) File "/home/docs/checkouts/readthedocs.org/user_builds/icb-scanpy/envs/latest/lib/python3.6/site-packages/sphinx/util/logging.py", line 406, in filter raise SphinxWarning(message) sphinx.errors.SphinxWarning: [autosummary] failed to import 'scanpy.external.pl.wishbone': no module named scanpy.external.pl.wishbone Warning, treated as error: [autosummary] failed to import 'scanpy.external.pl.wishbone': no module named scanpy.external.pl.wishbone