Read the Docs build information Build id: 493828 Project: icb-anndata Version: latest Commit: d746fc92bfaa6d97377485d48b8e7fda16c7da13 Date: 2020-12-01T07:32:53.188961Z State: finished Success: True [rtd-command-info] start-time: 2020-12-01T07:32:54.726441Z, end-time: 2020-12-01T07:32:56.307803Z, duration: 1, exit-code: 0 git clone --no-single-branch --depth 50 https://github.com/theislab/anndata.git . Cloning into '.'... [rtd-command-info] start-time: 2020-12-01T07:32:56.770273Z, end-time: 2020-12-01T07:32:56.830472Z, 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 d746fc9 Change ValueError to `NotImplementedError` [rtd-command-info] start-time: 2020-12-01T07:32:57.012507Z, end-time: 2020-12-01T07:32:57.064951Z, duration: 0, exit-code: 0 git clean -d -f -f [rtd-command-info] start-time: 2020-12-01T07:32:58.299631Z, end-time: 2020-12-01T07:33:02.459606Z, duration: 4, exit-code: 0 python3.6 -mvirtualenv Using base prefix '/home/docs/.pyenv/versions/3.6.12' 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: 2020-12-01T07:33:02.636837Z, end-time: 2020-12-01T07:33:04.327054Z, duration: 1, exit-code: 0 python -m pip install --upgrade --no-cache-dir pip Requirement already satisfied: pip in /home/docs/checkouts/readthedocs.org/user_builds/icb-anndata/envs/latest/lib/python3.6/site-packages (20.3) [rtd-command-info] start-time: 2020-12-01T07:33:04.531329Z, end-time: 2020-12-01T07:33:14.056229Z, duration: 9, exit-code: 0 python -m pip install --upgrade --no-cache-dir 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<2.2 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 docutils==0.14 Downloading docutils-0.14-py3-none-any.whl (543 kB) Collecting mock==1.0.1 Downloading mock-1.0.1.zip (861 kB) Collecting pillow==5.4.1 Downloading Pillow-5.4.1-cp36-cp36m-manylinux1_x86_64.whl (2.0 MB) Collecting readthedocs-sphinx-ext<2.2 Downloading readthedocs_sphinx_ext-2.1.1-py2.py3-none-any.whl (13 kB) Collecting recommonmark==0.5.0 Downloading recommonmark-0.5.0-py2.py3-none-any.whl (9.8 kB) Collecting setuptools==41.0.1 Downloading setuptools-41.0.1-py2.py3-none-any.whl (575 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 babel!=2.0,>=1.3 Downloading Babel-2.9.0-py2.py3-none-any.whl (8.8 MB) Collecting future Downloading future-0.18.2.tar.gz (829 kB) Collecting imagesize Downloading imagesize-1.2.0-py2.py3-none-any.whl (4.8 kB) Collecting Jinja2>=2.9 Downloading Jinja2-2.11.2-py2.py3-none-any.whl (125 kB) Collecting MarkupSafe>=0.23 Downloading MarkupSafe-1.1.1-cp36-cp36m-manylinux1_x86_64.whl (27 kB) Collecting packaging Downloading packaging-20.7-py2.py3-none-any.whl (35 kB) Collecting Pygments>=2.0 Downloading Pygments-2.7.2-py3-none-any.whl (948 kB) Collecting pyparsing>=2.0.2 Downloading pyparsing-2.4.7-py2.py3-none-any.whl (67 kB) Collecting pytz>=2015.7 Downloading pytz-2020.4-py2.py3-none-any.whl (509 kB) Collecting requests Downloading requests-2.25.0-py2.py3-none-any.whl (61 kB) Collecting certifi>=2017.4.17 Downloading certifi-2020.11.8-py2.py3-none-any.whl (155 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.10-py2.py3-none-any.whl (58 kB) Collecting six>=1.5 Downloading six-1.15.0-py2.py3-none-any.whl (10 kB) Collecting snowballstemmer>=1.1 Downloading snowballstemmer-2.0.0-py2.py3-none-any.whl (97 kB) Collecting sphinxcontrib-websupport Downloading sphinxcontrib_websupport-1.2.4-py2.py3-none-any.whl (39 kB) Collecting sphinxcontrib-serializinghtml Downloading sphinxcontrib_serializinghtml-1.1.4-py2.py3-none-any.whl (89 kB) Collecting urllib3<1.27,>=1.21.1 Downloading urllib3-1.26.2-py2.py3-none-any.whl (136 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=0f9dd4a1a3febcf70cfb97cbe81b21b4c1d0aaf627a0157c36b7400c9461b582 Stored in directory: /tmp/pip-ephem-wheel-cache-z47_g6n4/wheels/98/4d/ec/1aa935d28cb63b7b16037fc990302a34244ac3b0601a4e0c00 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=491059 sha256=f2177a592d1e4761464ef98a70fd2da85f10c94d1661f7e65e87f21740ad65a5 Stored in directory: /tmp/pip-ephem-wheel-cache-z47_g6n4/wheels/6e/9c/ed/4499c9865ac1002697793e0ae05ba6be33553d098f3347fb94 Successfully built mock future Installing collected packages: urllib3, sphinxcontrib-serializinghtml, pytz, pyparsing, MarkupSafe, idna, chardet, certifi, sphinxcontrib-websupport, snowballstemmer, six, setuptools, requests, Pygments, packaging, Jinja2, imagesize, future, docutils, babel, alabaster, sphinx, commonmark, sphinx-rtd-theme, recommonmark, readthedocs-sphinx-ext, pillow, mock Attempting uninstall: setuptools Found existing installation: setuptools 50.3.2 Uninstalling setuptools-50.3.2: Successfully uninstalled setuptools-50.3.2 Successfully installed Jinja2-2.11.2 MarkupSafe-1.1.1 Pygments-2.7.2 alabaster-0.7.12 babel-2.9.0 certifi-2020.11.8 chardet-3.0.4 commonmark-0.8.1 docutils-0.14 future-0.18.2 idna-2.10 imagesize-1.2.0 mock-1.0.1 packaging-20.7 pillow-5.4.1 pyparsing-2.4.7 pytz-2020.4 readthedocs-sphinx-ext-2.1.1 recommonmark-0.5.0 requests-2.25.0 setuptools-41.0.1 six-1.15.0 snowballstemmer-2.0.0 sphinx-1.8.5 sphinx-rtd-theme-0.4.3 sphinxcontrib-serializinghtml-1.1.4 sphinxcontrib-websupport-1.2.4 urllib3-1.26.2 [rtd-command-info] start-time: 2020-12-01T07:33:14.224476Z, end-time: 2020-12-01T07:33:41.836155Z, duration: 27, exit-code: 0 python -m pip install --upgrade --upgrade-strategy eager --no-cache-dir .[doc] Processing /home/docs/checkouts/readthedocs.org/user_builds/icb-anndata/checkouts/latest Installing build dependencies: started Installing build dependencies: finished with status 'done' Getting requirements to build wheel: started Getting requirements to build wheel: finished with status 'done' Preparing wheel metadata: started Preparing wheel metadata: finished with status 'done' Requirement already satisfied: packaging>=20 in /home/docs/checkouts/readthedocs.org/user_builds/icb-anndata/envs/latest/lib/python3.6/site-packages (from anndata==0.7.6.dev32+gd746fc9) (20.7) Requirement already satisfied: sphinx-rtd-theme in /home/docs/checkouts/readthedocs.org/user_builds/icb-anndata/envs/latest/lib/python3.6/site-packages (from anndata==0.7.6.dev32+gd746fc9) (0.4.3) Requirement already satisfied: packaging>=20 in /home/docs/checkouts/readthedocs.org/user_builds/icb-anndata/envs/latest/lib/python3.6/site-packages (from anndata==0.7.6.dev32+gd746fc9) (20.7) Collecting h5py Downloading h5py-3.1.0-cp36-cp36m-manylinux1_x86_64.whl (4.0 MB) Collecting cached-property Downloading cached_property-1.5.2-py2.py3-none-any.whl (7.6 kB) Collecting importlib-metadata>=0.7 Downloading importlib_metadata-3.1.0-py2.py3-none-any.whl (9.3 kB) Collecting natsort Downloading natsort-7.1.0-py3-none-any.whl (35 kB) Collecting numpy>=1.15 Downloading numpy-1.19.4-cp36-cp36m-manylinux2010_x86_64.whl (14.5 MB) 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>=20->anndata==0.7.6.dev32+gd746fc9) (2.4.7) Collecting pandas!=1.1,>=1.0 Downloading pandas-1.1.4-cp36-cp36m-manylinux1_x86_64.whl (9.5 MB) 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!=1.1,>=1.0->anndata==0.7.6.dev32+gd746fc9) (2020.4) Collecting python-dateutil>=2.7.3 Downloading python_dateutil-2.8.1-py2.py3-none-any.whl (227 kB) Requirement already satisfied: six>=1.5 in /home/docs/checkouts/readthedocs.org/user_builds/icb-anndata/envs/latest/lib/python3.6/site-packages (from python-dateutil>=2.7.3->pandas!=1.1,>=1.0->anndata==0.7.6.dev32+gd746fc9) (1.15.0) Collecting scanpydoc>=0.5 Downloading scanpydoc-0.5.5-py3-none-any.whl (28 kB) Collecting get_version Downloading get_version-2.1-py3-none-any.whl (43 kB) Requirement already satisfied: setuptools in /home/docs/checkouts/readthedocs.org/user_builds/icb-anndata/envs/latest/lib/python3.6/site-packages (from get_version->scanpydoc>=0.5->anndata==0.7.6.dev32+gd746fc9) (41.0.1) Collecting scipy~=1.0 Downloading scipy-1.5.4-cp36-cp36m-manylinux1_x86_64.whl (25.9 MB) Collecting setuptools Downloading setuptools-50.3.2-py3-none-any.whl (785 kB) Collecting sphinx>=2.0.1 Downloading Sphinx-3.3.1-py3-none-any.whl (2.9 MB) 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>=2.0.1->anndata==0.7.6.dev32+gd746fc9) (2.0.0) Requirement already satisfied: babel>=1.3 in /home/docs/checkouts/readthedocs.org/user_builds/icb-anndata/envs/latest/lib/python3.6/site-packages (from sphinx>=2.0.1->anndata==0.7.6.dev32+gd746fc9) (2.9.0) Requirement already satisfied: sphinxcontrib-serializinghtml in /home/docs/checkouts/readthedocs.org/user_builds/icb-anndata/envs/latest/lib/python3.6/site-packages (from sphinx>=2.0.1->anndata==0.7.6.dev32+gd746fc9) (1.1.4) 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>=2.0.1->anndata==0.7.6.dev32+gd746fc9) (2.7.2) Requirement already satisfied: docutils>=0.12 in /home/docs/checkouts/readthedocs.org/user_builds/icb-anndata/envs/latest/lib/python3.6/site-packages (from sphinx>=2.0.1->anndata==0.7.6.dev32+gd746fc9) (0.14) 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>=2.0.1->anndata==0.7.6.dev32+gd746fc9) (0.7.12) Requirement already satisfied: imagesize in /home/docs/checkouts/readthedocs.org/user_builds/icb-anndata/envs/latest/lib/python3.6/site-packages (from sphinx>=2.0.1->anndata==0.7.6.dev32+gd746fc9) (1.2.0) Requirement already satisfied: requests>=2.5.0 in /home/docs/checkouts/readthedocs.org/user_builds/icb-anndata/envs/latest/lib/python3.6/site-packages (from sphinx>=2.0.1->anndata==0.7.6.dev32+gd746fc9) (2.25.0) 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>=2.0.1->anndata==0.7.6.dev32+gd746fc9) (2.11.2) Requirement already satisfied: packaging>=20 in /home/docs/checkouts/readthedocs.org/user_builds/icb-anndata/envs/latest/lib/python3.6/site-packages (from anndata==0.7.6.dev32+gd746fc9) (20.7) Requirement already satisfied: setuptools in /home/docs/checkouts/readthedocs.org/user_builds/icb-anndata/envs/latest/lib/python3.6/site-packages (from get_version->scanpydoc>=0.5->anndata==0.7.6.dev32+gd746fc9) (41.0.1) 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!=1.1,>=1.0->anndata==0.7.6.dev32+gd746fc9) (2020.4) Collecting docutils>=0.12 Downloading docutils-0.16-py2.py3-none-any.whl (548 kB) 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>=2.0.1->anndata==0.7.6.dev32+gd746fc9) (1.1.1) Requirement already satisfied: idna<3,>=2.5 in /home/docs/checkouts/readthedocs.org/user_builds/icb-anndata/envs/latest/lib/python3.6/site-packages (from requests>=2.5.0->sphinx>=2.0.1->anndata==0.7.6.dev32+gd746fc9) (2.10) 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.5.0->sphinx>=2.0.1->anndata==0.7.6.dev32+gd746fc9) (2020.11.8) Requirement already satisfied: chardet<4,>=3.0.2 in /home/docs/checkouts/readthedocs.org/user_builds/icb-anndata/envs/latest/lib/python3.6/site-packages (from requests>=2.5.0->sphinx>=2.0.1->anndata==0.7.6.dev32+gd746fc9) (3.0.4) Requirement already satisfied: urllib3<1.27,>=1.21.1 in /home/docs/checkouts/readthedocs.org/user_builds/icb-anndata/envs/latest/lib/python3.6/site-packages (from requests>=2.5.0->sphinx>=2.0.1->anndata==0.7.6.dev32+gd746fc9) (1.26.2) Collecting sphinx-autodoc-typehints>=1.11.0 Downloading sphinx_autodoc_typehints-1.11.1-py3-none-any.whl (8.7 kB) Collecting sphinx-issues Downloading sphinx_issues-1.2.0-py2.py3-none-any.whl (5.8 kB) Collecting sphinx-rtd-theme Downloading sphinx_rtd_theme-0.5.0-py2.py3-none-any.whl (10.8 MB) Collecting sphinxcontrib-applehelp Downloading sphinxcontrib_applehelp-1.0.2-py2.py3-none-any.whl (121 kB) Collecting sphinxcontrib-devhelp Downloading sphinxcontrib_devhelp-1.0.2-py2.py3-none-any.whl (84 kB) Collecting sphinxcontrib-htmlhelp Downloading sphinxcontrib_htmlhelp-1.0.3-py2.py3-none-any.whl (96 kB) Collecting sphinxcontrib-jsmath Downloading sphinxcontrib_jsmath-1.0.1-py2.py3-none-any.whl (5.1 kB) Collecting sphinxcontrib-qthelp Downloading sphinxcontrib_qthelp-1.0.3-py2.py3-none-any.whl (90 kB) Collecting typing-extensions Downloading typing_extensions-3.7.4.3-py3-none-any.whl (22 kB) Collecting zipp>=0.5 Downloading zipp-3.4.0-py3-none-any.whl (5.2 kB) Building wheels for collected packages: anndata Building wheel for anndata (PEP 517): started Building wheel for anndata (PEP 517): finished with status 'done' Created wheel for anndata: filename=anndata-0.7.6.dev32+gd746fc9-py3-none-any.whl size=121806 sha256=f423cb9968b932c95c504fbf984b95890dee82410b71362e198a3c95db366694 Stored in directory: /tmp/pip-ephem-wheel-cache-cvp7iq9o/wheels/3f/90/f9/eb6a6b02b86a91fc95cf9cd39a975387ac3995e82d2c2380c7 Successfully built anndata Installing collected packages: zipp, sphinxcontrib-qthelp, sphinxcontrib-jsmath, sphinxcontrib-htmlhelp, sphinxcontrib-devhelp, sphinxcontrib-applehelp, setuptools, python-dateutil, numpy, docutils, cached-property, sphinx, scipy, pandas, natsort, importlib-metadata, h5py, get-version, typing-extensions, sphinx-rtd-theme, sphinx-issues, sphinx-autodoc-typehints, scanpydoc, anndata Attempting uninstall: setuptools Found existing installation: setuptools 41.0.1 Uninstalling setuptools-41.0.1: Successfully uninstalled setuptools-41.0.1 Attempting uninstall: docutils Found existing installation: docutils 0.14 Uninstalling docutils-0.14: Successfully uninstalled docutils-0.14 Attempting uninstall: sphinx Found existing installation: Sphinx 1.8.5 Uninstalling Sphinx-1.8.5: Successfully uninstalled Sphinx-1.8.5 Attempting uninstall: sphinx-rtd-theme Found existing installation: sphinx-rtd-theme 0.4.3 Uninstalling sphinx-rtd-theme-0.4.3: Successfully uninstalled sphinx-rtd-theme-0.4.3 Successfully installed anndata-0.7.6.dev32+gd746fc9 cached-property-1.5.2 docutils-0.16 get-version-2.1 h5py-3.1.0 importlib-metadata-3.1.0 natsort-7.1.0 numpy-1.19.4 pandas-1.1.4 python-dateutil-2.8.1 scanpydoc-0.5.5 scipy-1.5.4 setuptools-50.3.2 sphinx-3.3.1 sphinx-autodoc-typehints-1.11.1 sphinx-issues-1.2.0 sphinx-rtd-theme-0.5.0 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 typing-extensions-3.7.4.3 zipp-3.4.0 [rtd-command-info] start-time: 2020-12-01T07:33:43.403860Z, end-time: 2020-12-01T07:33:43.479225Z, duration: 0, exit-code: 0 cat docs/conf.py import sys import logging from pathlib import Path from datetime import datetime from sphinx.application import Sphinx HERE = Path(__file__).parent sys.path[:0] = [str(HERE.parent), str(HERE / "extensions")] 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", "sphinx_autodoc_typehints", # needs to be after napoleon "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 nitpicky = True # Report broken links suppress_warnings = ["ref.citation"] def work_around_issue_6785(): """See https://github.com/sphinx-doc/sphinx/issues/6785""" from docutils.parsers.rst import directives from sphinx.ext import autodoc from sphinx.domains.python import PyAttribute # check if the code changes on the sphinx side and we can remove this assert autodoc.PropertyDocumenter.directivetype == "method" autodoc.PropertyDocumenter.directivetype = "attribute" def get_signature_prefix(self, sig: str) -> str: # TODO: abstract attributes return "property " if "property" in self.options else "" PyAttribute.option_spec["property"] = directives.flag PyAttribute.get_signature_prefix = get_signature_prefix def setup(app: Sphinx): work_around_issue_6785() # Don’t allow broken links. DO NOT CHANGE THIS LINE, fix problems instead. app.warningiserror = True 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), zarr=("https://zarr.readthedocs.io/en/stable/", None), xarray=("http://xarray.pydata.org/en/stable/", None), ) qualname_overrides = { "anndata._core.anndata.AnnData": "anndata.AnnData", # Temporarily "anndata._core.raw.Raw": "anndata.AnnData", "anndata._core.views.ArrayView": "numpy.ndarray", **{ f"anndata._core.aligned_mapping.{cls}{kind}": "typing.Mapping" for cls in "Layers AxisArrays PairwiseArrays".split() for kind in ["", "View"] }, } # -- Options for HTML output ---------------------------------------------- html_theme = "scanpydoc" html_theme_options = dict(navigation_depth=4) 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 ) issues_github_path = "{github_user}/{github_repo}".format_map(html_context) html_show_sphinx = False # -- 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://assets.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://assets.readthedocs.com/", 'PRODUCTION_DOMAIN': "readthedocs.com", 'versions': [ ("latest", "/en/latest/"), ("stable", "/en/stable/"), ("refpaths", "/en/refpaths/"), ], 'downloads': [ ], 'subprojects': [ ], 'slug': 'icb-anndata', 'name': u'anndata', 'rtd_language': u'en', 'programming_language': u'py', 'canonical_url': 'https://anndata.readthedocs.io/en/latest/', 'analytics_code': 'None', 'single_version': False, 'conf_py_path': '/docs/', 'api_host': 'https://readthedocs.com', 'github_user': 'theislab', 'proxied_api_host': '/_', '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, 'docsearch_disabled': False, 'user_analytics_code': '', 'global_analytics_code': 'UA-17997319-2', 'commit': 'd746fc92', } 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' # Make sure our build directory is always excluded exclude_patterns = globals().get('exclude_patterns', []) exclude_patterns.extend(['_build']) [rtd-command-info] start-time: 2020-12-01T07:33:43.649362Z, end-time: 2020-12-01T07:33:54.479386Z, duration: 10, exit-code: 0 python sphinx-build -T -E -b readthedocs -d _build/doctrees-readthedocs -D language=en . _build/html Running Sphinx v3.3.1 loading translations [en]... done making output directory... done loading intersphinx inventory from http://docs.h5py.org/en/latest/objects.inv... loading intersphinx inventory from https://linnarssonlab.org/loompy/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://scikit-learn.org/stable/objects.inv... loading intersphinx inventory from https://zarr.readthedocs.io/en/stable/objects.inv... loading intersphinx inventory from http://xarray.pydata.org/en/stable/objects.inv... intersphinx inventory has moved: https://docs.scipy.org/doc/numpy/objects.inv -> https://numpy.org/doc/stable/objects.inv intersphinx inventory has moved: http://docs.h5py.org/en/latest/objects.inv -> https://docs.h5py.org/en/latest/objects.inv [autosummary] generating autosummary for: _key_contributors.rst, api.rst, benchmarks.rst, concatenation.rst, fileformat-prose.rst, index.rst, news.rst, references.rst, release-latest.rst, release-notes.rst [autosummary] generating autosummary for: /home/docs/checkouts/readthedocs.org/user_builds/icb-anndata/checkouts/latest/docs/anndata.AnnData.rst, /home/docs/checkouts/readthedocs.org/user_builds/icb-anndata/checkouts/latest/docs/anndata.AnnData.write.rst, /home/docs/checkouts/readthedocs.org/user_builds/icb-anndata/checkouts/latest/docs/anndata.AnnData.write_csvs.rst, /home/docs/checkouts/readthedocs.org/user_builds/icb-anndata/checkouts/latest/docs/anndata.AnnData.write_loom.rst, /home/docs/checkouts/readthedocs.org/user_builds/icb-anndata/checkouts/latest/docs/anndata.AnnData.write_zarr.rst, /home/docs/checkouts/readthedocs.org/user_builds/icb-anndata/checkouts/latest/docs/anndata.ImplicitModificationWarning.rst, /home/docs/checkouts/readthedocs.org/user_builds/icb-anndata/checkouts/latest/docs/anndata.concat.rst, /home/docs/checkouts/readthedocs.org/user_builds/icb-anndata/checkouts/latest/docs/anndata.read_csv.rst, /home/docs/checkouts/readthedocs.org/user_builds/icb-anndata/checkouts/latest/docs/anndata.read_excel.rst, /home/docs/checkouts/readthedocs.org/user_builds/icb-anndata/checkouts/latest/docs/anndata.read_h5ad.rst, /home/docs/checkouts/readthedocs.org/user_builds/icb-anndata/checkouts/latest/docs/anndata.read_hdf.rst, /home/docs/checkouts/readthedocs.org/user_builds/icb-anndata/checkouts/latest/docs/anndata.read_loom.rst, /home/docs/checkouts/readthedocs.org/user_builds/icb-anndata/checkouts/latest/docs/anndata.read_mtx.rst, /home/docs/checkouts/readthedocs.org/user_builds/icb-anndata/checkouts/latest/docs/anndata.read_text.rst, /home/docs/checkouts/readthedocs.org/user_builds/icb-anndata/checkouts/latest/docs/anndata.read_umi_tools.rst, /home/docs/checkouts/readthedocs.org/user_builds/icb-anndata/checkouts/latest/docs/anndata.read_zarr.rst [autosummary] generating autosummary for: /home/docs/checkouts/readthedocs.org/user_builds/icb-anndata/checkouts/latest/docs/anndata.AnnData.T.rst, /home/docs/checkouts/readthedocs.org/user_builds/icb-anndata/checkouts/latest/docs/anndata.AnnData.X.rst, /home/docs/checkouts/readthedocs.org/user_builds/icb-anndata/checkouts/latest/docs/anndata.AnnData.chunk_X.rst, /home/docs/checkouts/readthedocs.org/user_builds/icb-anndata/checkouts/latest/docs/anndata.AnnData.chunked_X.rst, /home/docs/checkouts/readthedocs.org/user_builds/icb-anndata/checkouts/latest/docs/anndata.AnnData.concatenate.rst, /home/docs/checkouts/readthedocs.org/user_builds/icb-anndata/checkouts/latest/docs/anndata.AnnData.copy.rst, /home/docs/checkouts/readthedocs.org/user_builds/icb-anndata/checkouts/latest/docs/anndata.AnnData.filename.rst, /home/docs/checkouts/readthedocs.org/user_builds/icb-anndata/checkouts/latest/docs/anndata.AnnData.is_view.rst, /home/docs/checkouts/readthedocs.org/user_builds/icb-anndata/checkouts/latest/docs/anndata.AnnData.isbacked.rst, /home/docs/checkouts/readthedocs.org/user_builds/icb-anndata/checkouts/latest/docs/anndata.AnnData.layers.rst, ..., /home/docs/checkouts/readthedocs.org/user_builds/icb-anndata/checkouts/latest/docs/anndata.AnnData.var_names_make_unique.rst, /home/docs/checkouts/readthedocs.org/user_builds/icb-anndata/checkouts/latest/docs/anndata.AnnData.var_vector.rst, /home/docs/checkouts/readthedocs.org/user_builds/icb-anndata/checkouts/latest/docs/anndata.AnnData.varm.rst, /home/docs/checkouts/readthedocs.org/user_builds/icb-anndata/checkouts/latest/docs/anndata.AnnData.varm_keys.rst, /home/docs/checkouts/readthedocs.org/user_builds/icb-anndata/checkouts/latest/docs/anndata.AnnData.varp.rst, /home/docs/checkouts/readthedocs.org/user_builds/icb-anndata/checkouts/latest/docs/anndata.AnnData.write.rst, /home/docs/checkouts/readthedocs.org/user_builds/icb-anndata/checkouts/latest/docs/anndata.AnnData.write_csvs.rst, /home/docs/checkouts/readthedocs.org/user_builds/icb-anndata/checkouts/latest/docs/anndata.AnnData.write_h5ad.rst, /home/docs/checkouts/readthedocs.org/user_builds/icb-anndata/checkouts/latest/docs/anndata.AnnData.write_loom.rst, /home/docs/checkouts/readthedocs.org/user_builds/icb-anndata/checkouts/latest/docs/anndata.AnnData.write_zarr.rst building [mo]: targets for 0 po files that are out of date building [readthedocs]: targets for 10 source files that are out of date updating environment: [new config] 63 added, 0 changed, 0 removed reading sources... [ 1%] _key_contributors reading sources... [ 3%] anndata.AnnData reading sources... [ 4%] anndata.AnnData.T reading sources... [ 6%] anndata.AnnData.X reading sources... [ 7%] anndata.AnnData.chunk_X reading sources... [ 9%] anndata.AnnData.chunked_X reading sources... [ 11%] anndata.AnnData.concatenate reading sources... [ 12%] anndata.AnnData.copy reading sources... [ 14%] anndata.AnnData.filename reading sources... [ 15%] anndata.AnnData.is_view reading sources... [ 17%] anndata.AnnData.isbacked reading sources... [ 19%] anndata.AnnData.layers reading sources... [ 20%] anndata.AnnData.n_obs reading sources... [ 22%] anndata.AnnData.n_vars reading sources... [ 23%] anndata.AnnData.obs reading sources... [ 25%] anndata.AnnData.obs_keys reading sources... [ 26%] anndata.AnnData.obs_names reading sources... [ 28%] anndata.AnnData.obs_names_make_unique reading sources... [ 30%] anndata.AnnData.obs_vector reading sources... [ 31%] anndata.AnnData.obsm reading sources... [ 33%] anndata.AnnData.obsm_keys reading sources... [ 34%] anndata.AnnData.obsp reading sources... [ 36%] anndata.AnnData.raw reading sources... [ 38%] anndata.AnnData.rename_categories reading sources... [ 39%] anndata.AnnData.shape reading sources... [ 41%] anndata.AnnData.strings_to_categoricals reading sources... [ 42%] anndata.AnnData.to_df reading sources... [ 44%] anndata.AnnData.transpose reading sources... [ 46%] anndata.AnnData.uns reading sources... [ 47%] anndata.AnnData.uns_keys reading sources... [ 49%] anndata.AnnData.var reading sources... [ 50%] anndata.AnnData.var_keys reading sources... [ 52%] anndata.AnnData.var_names reading sources... [ 53%] anndata.AnnData.var_names_make_unique reading sources... [ 55%] anndata.AnnData.var_vector reading sources... [ 57%] anndata.AnnData.varm reading sources... [ 58%] anndata.AnnData.varm_keys reading sources... [ 60%] anndata.AnnData.varp reading sources... [ 61%] anndata.AnnData.write reading sources... [ 63%] anndata.AnnData.write_csvs reading sources... [ 65%] anndata.AnnData.write_h5ad reading sources... [ 66%] anndata.AnnData.write_loom reading sources... [ 68%] anndata.AnnData.write_zarr reading sources... [ 69%] anndata.ImplicitModificationWarning reading sources... [ 71%] anndata.concat reading sources... [ 73%] anndata.read_csv reading sources... [ 74%] anndata.read_excel reading sources... [ 76%] anndata.read_h5ad reading sources... [ 77%] anndata.read_hdf reading sources... [ 79%] anndata.read_loom reading sources... [ 80%] anndata.read_mtx reading sources... [ 82%] anndata.read_text reading sources... [ 84%] anndata.read_umi_tools reading sources... [ 85%] anndata.read_zarr reading sources... [ 87%] api reading sources... [ 88%] benchmarks reading sources... [ 90%] concatenation reading sources... [ 92%] fileformat-prose reading sources... [ 93%] index reading sources... [ 95%] news reading sources... [ 96%] references reading sources... [ 98%] release-latest reading sources... [100%] release-notes looking for now-outdated files... none found pickling environment... done checking consistency... done preparing documents... done writing output... [ 1%] _key_contributors writing output... [ 3%] anndata.AnnData writing output... [ 4%] anndata.AnnData.T writing output... [ 6%] anndata.AnnData.X writing output... [ 7%] anndata.AnnData.chunk_X writing output... [ 9%] anndata.AnnData.chunked_X writing output... [ 11%] anndata.AnnData.concatenate writing output... [ 12%] anndata.AnnData.copy writing output... [ 14%] anndata.AnnData.filename writing output... [ 15%] anndata.AnnData.is_view writing output... [ 17%] anndata.AnnData.isbacked writing output... [ 19%] anndata.AnnData.layers writing output... [ 20%] anndata.AnnData.n_obs writing output... [ 22%] anndata.AnnData.n_vars writing output... [ 23%] anndata.AnnData.obs writing output... [ 25%] anndata.AnnData.obs_keys writing output... [ 26%] anndata.AnnData.obs_names writing output... [ 28%] anndata.AnnData.obs_names_make_unique writing output... [ 30%] anndata.AnnData.obs_vector writing output... [ 31%] anndata.AnnData.obsm writing output... [ 33%] anndata.AnnData.obsm_keys writing output... [ 34%] anndata.AnnData.obsp writing output... [ 36%] anndata.AnnData.raw writing output... [ 38%] anndata.AnnData.rename_categories writing output... [ 39%] anndata.AnnData.shape writing output... [ 41%] anndata.AnnData.strings_to_categoricals writing output... [ 42%] anndata.AnnData.to_df writing output... [ 44%] anndata.AnnData.transpose writing output... [ 46%] anndata.AnnData.uns writing output... [ 47%] anndata.AnnData.uns_keys writing output... [ 49%] anndata.AnnData.var writing output... [ 50%] anndata.AnnData.var_keys writing output... [ 52%] anndata.AnnData.var_names writing output... [ 53%] anndata.AnnData.var_names_make_unique writing output... [ 55%] anndata.AnnData.var_vector writing output... [ 57%] anndata.AnnData.varm writing output... [ 58%] anndata.AnnData.varm_keys writing output... [ 60%] anndata.AnnData.varp writing output... [ 61%] anndata.AnnData.write writing output... [ 63%] anndata.AnnData.write_csvs writing output... [ 65%] anndata.AnnData.write_h5ad writing output... [ 66%] anndata.AnnData.write_loom writing output... [ 68%] anndata.AnnData.write_zarr writing output... [ 69%] anndata.ImplicitModificationWarning writing output... [ 71%] anndata.concat writing output... [ 73%] anndata.read_csv writing output... [ 74%] anndata.read_excel writing output... [ 76%] anndata.read_h5ad writing output... [ 77%] anndata.read_hdf writing output... [ 79%] anndata.read_loom writing output... [ 80%] anndata.read_mtx writing output... [ 82%] anndata.read_text writing output... [ 84%] anndata.read_umi_tools writing output... [ 85%] anndata.read_zarr writing output... [ 87%] api writing output... [ 88%] benchmarks writing output... [ 90%] concatenation writing output... [ 92%] fileformat-prose writing output... [ 93%] index writing output... [ 95%] news writing output... [ 96%] references writing output... [ 98%] release-latest writing output... [100%] release-notes generating indices... genindex py-modindex done writing additional pages... search done copying static files... done copying extra files... done dumping search index in English (code: en)... done dumping object inventory... done build succeeded. The HTML pages are in _build/html. Updating searchtools for Read the Docs search...