Read the Docs build information Build id: 18869 Project: extra-hed Version: latest Commit: 207ca9d1fe73d9177581aca3842c93c1c6adb600 Date: 2020-08-28T13:25:42.076913Z State: finished Success: False [rtd-command-info] start-time: 2020-08-28T18:25:44.785000Z, end-time: 2020-08-28T18:25:58.459000Z, duration: 13, exit-code: 0 python3 -mvirtualenv --no-site-packages --no-download /user_builds/extra-hed/envs/latest Using base prefix '/usr' New python executable in /user_builds/extra-hed/envs/latest/bin/python3 Not overwriting existing python script /user_builds/extra-hed/envs/latest/bin/python (you must use /user_builds/extra-hed/envs/latest/bin/python3) Installing setuptools, pip, wheel...done. [rtd-command-info] start-time: 2020-08-28T18:25:58.521000Z, end-time: 2020-08-28T18:26:43.582000Z, duration: 45, exit-code: 0 python /user_builds/extra-hed/envs/latest/bin/pip install --use-wheel -U --cache-dir /user_builds/extra-hed/.cache/pip sphinx==1.3.5 Pygments==2.1.3 setuptools==20.1.1 docutils==0.12 mkdocs==0.15.0 PyYAML==5.2 mock==1.0.1 pillow==2.6.1 git+https://github.com/rtfd/readthedocs-sphinx-ext.git@0.6-alpha#egg=readthedocs-sphinx-ext sphinx-rtd-theme==0.1.9 alabaster>=0.7,<0.8,!=0.7.5 commonmark==0.5.4 recommonmark==0.1.1 Collecting sphinx==1.3.5 Using cached https://files.pythonhosted.org/packages/ff/91/45883bc962bda1be7e78039b41cc15e1eb3327ec75679eedd067b5d07bd5/Sphinx-1.3.5-py2.py3-none-any.whl Requirement already up-to-date: Pygments==2.1.3 in /user_builds/extra-hed/envs/latest/lib/python3.4/site-packages Collecting setuptools==20.1.1 Using cached https://files.pythonhosted.org/packages/e8/82/3b5455f74bf9ac0757d09c625b7741e6fc284d7519cffc3babb6c5173cf5/setuptools-20.1.1-py2.py3-none-any.whl Requirement already up-to-date: docutils==0.12 in /user_builds/extra-hed/envs/latest/lib/python3.4/site-packages Requirement already up-to-date: mkdocs==0.15.0 in /user_builds/extra-hed/envs/latest/lib/python3.4/site-packages Requirement already up-to-date: PyYAML==5.2 in /user_builds/extra-hed/envs/latest/lib/python3.4/site-packages Requirement already up-to-date: mock==1.0.1 in /user_builds/extra-hed/envs/latest/lib/python3.4/site-packages Requirement already up-to-date: pillow==2.6.1 in /user_builds/extra-hed/envs/latest/lib/python3.4/site-packages Collecting readthedocs-sphinx-ext from git+https://github.com/rtfd/readthedocs-sphinx-ext.git@0.6-alpha#egg=readthedocs-sphinx-ext Cloning https://github.com/rtfd/readthedocs-sphinx-ext.git (to 0.6-alpha) to /tmp/pip-build-pvizcm1d/readthedocs-sphinx-ext Requirement already up-to-date: sphinx-rtd-theme==0.1.9 in /user_builds/extra-hed/envs/latest/lib/python3.4/site-packages Requirement already up-to-date: alabaster!=0.7.5,<0.8,>=0.7 in /user_builds/extra-hed/envs/latest/lib/python3.4/site-packages Requirement already up-to-date: commonmark==0.5.4 in /user_builds/extra-hed/envs/latest/lib/python3.4/site-packages Requirement already up-to-date: recommonmark==0.1.1 in /user_builds/extra-hed/envs/latest/lib/python3.4/site-packages Requirement already up-to-date: six>=1.4 in /user_builds/extra-hed/envs/latest/lib/python3.4/site-packages (from sphinx==1.3.5) Requirement already up-to-date: Jinja2>=2.3 in /user_builds/extra-hed/envs/latest/lib/python3.4/site-packages (from sphinx==1.3.5) Requirement already up-to-date: snowballstemmer>=1.1 in /user_builds/extra-hed/envs/latest/lib/python3.4/site-packages (from sphinx==1.3.5) Requirement already up-to-date: babel!=2.0,>=1.3 in /user_builds/extra-hed/envs/latest/lib/python3.4/site-packages (from sphinx==1.3.5) Requirement already up-to-date: mkdocs-bootstrap>=0.1.1 in /user_builds/extra-hed/envs/latest/lib/python3.4/site-packages (from mkdocs==0.15.0) Requirement already up-to-date: click>=4.0 in /user_builds/extra-hed/envs/latest/lib/python3.4/site-packages (from mkdocs==0.15.0) Requirement already up-to-date: mkdocs-bootswatch>=0.1.0 in /user_builds/extra-hed/envs/latest/lib/python3.4/site-packages (from mkdocs==0.15.0) Requirement already up-to-date: Markdown>=2.3.1 in /user_builds/extra-hed/envs/latest/lib/python3.4/site-packages (from mkdocs==0.15.0) Requirement already up-to-date: tornado>=4.1 in /user_builds/extra-hed/envs/latest/lib/python3.4/site-packages (from mkdocs==0.15.0) Requirement already up-to-date: livereload>=2.3.2 in /user_builds/extra-hed/envs/latest/lib/python3.4/site-packages (from mkdocs==0.15.0) Requirement already up-to-date: requests in /user_builds/extra-hed/envs/latest/lib/python3.4/site-packages (from readthedocs-sphinx-ext) Requirement already up-to-date: nilsimsa>=0.3.7 in /user_builds/extra-hed/envs/latest/lib/python3.4/site-packages (from readthedocs-sphinx-ext) Requirement already up-to-date: MarkupSafe>=0.23 in /user_builds/extra-hed/envs/latest/lib/python3.4/site-packages (from Jinja2>=2.3->sphinx==1.3.5) Requirement already up-to-date: pytz>=2015.7 in /user_builds/extra-hed/envs/latest/lib/python3.4/site-packages (from babel!=2.0,>=1.3->sphinx==1.3.5) Requirement already up-to-date: backports-abc>=0.4 in /user_builds/extra-hed/envs/latest/lib/python3.4/site-packages (from tornado>=4.1->mkdocs==0.15.0) Requirement already up-to-date: chardet<3.1.0,>=3.0.2 in /user_builds/extra-hed/envs/latest/lib/python3.4/site-packages (from requests->readthedocs-sphinx-ext) Requirement already up-to-date: idna<2.9,>=2.5 in /user_builds/extra-hed/envs/latest/lib/python3.4/site-packages (from requests->readthedocs-sphinx-ext) Requirement already up-to-date: urllib3<1.25,>=1.21.1 in /user_builds/extra-hed/envs/latest/lib/python3.4/site-packages (from requests->readthedocs-sphinx-ext) Requirement already up-to-date: certifi>=2017.4.17 in /user_builds/extra-hed/envs/latest/lib/python3.4/site-packages (from requests->readthedocs-sphinx-ext) Installing collected packages: sphinx, setuptools, readthedocs-sphinx-ext Found existing installation: Sphinx 1.8.5 Uninstalling Sphinx-1.8.5: Successfully uninstalled Sphinx-1.8.5 Found existing installation: setuptools 28.8.0 Uninstalling setuptools-28.8.0: Successfully uninstalled setuptools-28.8.0 Found existing installation: readthedocs-sphinx-ext 0.5.4 Uninstalling readthedocs-sphinx-ext-0.5.4: Successfully uninstalled readthedocs-sphinx-ext-0.5.4 Running setup.py install for readthedocs-sphinx-ext: started Running setup.py install for readthedocs-sphinx-ext: finished with status 'done' Successfully installed readthedocs-sphinx-ext-0.5.4 setuptools-20.1.1 sphinx-1.3.5 You are using pip version 9.0.1, however version 20.2.2 is available. You should consider upgrading via the 'pip install --upgrade pip' command. [rtd-command-info] start-time: 2020-08-28T18:26:43.666000Z, end-time: 2020-08-28T18:27:11.367000Z, duration: 27, exit-code: 0 python /user_builds/extra-hed/envs/latest/bin/pip install --exists-action=w --cache-dir /user_builds/extra-hed/.cache/pip -r/user_builds/extra-hed/checkouts/latest/docs/requirements.txt Collecting git+https://git.xfel.eu/gitlab/xfel-rtd/rtd-conf.git (from -r /user_builds/extra-hed/checkouts/latest/docs/requirements.txt (line 6)) Cloning https://git.xfel.eu/gitlab/xfel-rtd/rtd-conf.git to /tmp/pip-2dheqz12-build Requirement already satisfied (use --upgrade to upgrade): RTDConf==0.1 from git+https://git.xfel.eu/gitlab/xfel-rtd/rtd-conf.git in /user_builds/extra-hed/envs/latest/lib/python3.4/site-packages (from -r /user_builds/extra-hed/checkouts/latest/docs/requirements.txt (line 6)) Collecting sphinx>=1.8 (from -r /user_builds/extra-hed/checkouts/latest/docs/requirements.txt (line 1)) Using cached https://files.pythonhosted.org/packages/7d/66/a4af242b4348b729b9d46ce5db23943ce9bca7da9bbe2ece60dc27f26420/Sphinx-1.8.5-py2.py3-none-any.whl Requirement already satisfied: sphinx_rtd_theme in /user_builds/extra-hed/envs/latest/lib/python3.4/site-packages (from -r /user_builds/extra-hed/checkouts/latest/docs/requirements.txt (line 2)) Requirement already satisfied: nbsphinx in /user_builds/extra-hed/envs/latest/lib/python3.4/site-packages (from -r /user_builds/extra-hed/checkouts/latest/docs/requirements.txt (line 3)) Requirement already satisfied: pandoc in /user_builds/extra-hed/envs/latest/lib/python3.4/site-packages (from -r /user_builds/extra-hed/checkouts/latest/docs/requirements.txt (line 4)) Requirement already satisfied: pint in /user_builds/extra-hed/envs/latest/lib/python3.4/site-packages (from -r /user_builds/extra-hed/checkouts/latest/docs/requirements.txt (line 5)) Requirement already satisfied: slumber in /user_builds/extra-hed/envs/latest/lib/python3.4/site-packages (from -r /user_builds/extra-hed/checkouts/latest/docs/requirements.txt (line 7)) Requirement already satisfied: breathe==4.7.3 in /user_builds/extra-hed/envs/latest/lib/python3.4/site-packages (from -r /user_builds/extra-hed/checkouts/latest/docs/requirements.txt (line 8)) Requirement already satisfied: numpy in /user_builds/extra-hed/envs/latest/lib/python3.4/site-packages (from -r /user_builds/extra-hed/checkouts/latest/docs/requirements.txt (line 9)) Requirement already satisfied: matplotlib in /user_builds/extra-hed/envs/latest/lib/python3.4/site-packages (from -r /user_builds/extra-hed/checkouts/latest/docs/requirements.txt (line 10)) Requirement already satisfied: typing in /user_builds/extra-hed/envs/latest/lib/python3.4/site-packages (from -r /user_builds/extra-hed/checkouts/latest/docs/requirements.txt (line 11)) Requirement already satisfied: traits==4.6.0 in /user_builds/extra-hed/envs/latest/lib/python3.4/site-packages (from -r /user_builds/extra-hed/checkouts/latest/docs/requirements.txt (line 12)) Requirement already satisfied: lxml==3.6.4 in /user_builds/extra-hed/envs/latest/lib/python3.4/site-packages (from -r /user_builds/extra-hed/checkouts/latest/docs/requirements.txt (line 13)) Requirement already satisfied: alabaster<0.8,>=0.7 in /user_builds/extra-hed/envs/latest/lib/python3.4/site-packages (from sphinx>=1.8->-r /user_builds/extra-hed/checkouts/latest/docs/requirements.txt (line 1)) Requirement already satisfied: imagesize in /user_builds/extra-hed/envs/latest/lib/python3.4/site-packages (from sphinx>=1.8->-r /user_builds/extra-hed/checkouts/latest/docs/requirements.txt (line 1)) Requirement already satisfied: packaging in /user_builds/extra-hed/envs/latest/lib/python3.4/site-packages (from sphinx>=1.8->-r /user_builds/extra-hed/checkouts/latest/docs/requirements.txt (line 1)) Requirement already satisfied: Pygments>=2.0 in /user_builds/extra-hed/envs/latest/lib/python3.4/site-packages (from sphinx>=1.8->-r /user_builds/extra-hed/checkouts/latest/docs/requirements.txt (line 1)) Requirement already satisfied: Jinja2>=2.3 in /user_builds/extra-hed/envs/latest/lib/python3.4/site-packages (from sphinx>=1.8->-r /user_builds/extra-hed/checkouts/latest/docs/requirements.txt (line 1)) Requirement already satisfied: babel!=2.0,>=1.3 in /user_builds/extra-hed/envs/latest/lib/python3.4/site-packages (from sphinx>=1.8->-r /user_builds/extra-hed/checkouts/latest/docs/requirements.txt (line 1)) Requirement already satisfied: six>=1.5 in /user_builds/extra-hed/envs/latest/lib/python3.4/site-packages (from sphinx>=1.8->-r /user_builds/extra-hed/checkouts/latest/docs/requirements.txt (line 1)) Requirement already satisfied: requests>=2.0.0 in /user_builds/extra-hed/envs/latest/lib/python3.4/site-packages (from sphinx>=1.8->-r /user_builds/extra-hed/checkouts/latest/docs/requirements.txt (line 1)) Requirement already satisfied: sphinxcontrib-websupport in /user_builds/extra-hed/envs/latest/lib/python3.4/site-packages (from sphinx>=1.8->-r /user_builds/extra-hed/checkouts/latest/docs/requirements.txt (line 1)) Requirement already satisfied: docutils>=0.11 in /user_builds/extra-hed/envs/latest/lib/python3.4/site-packages (from sphinx>=1.8->-r /user_builds/extra-hed/checkouts/latest/docs/requirements.txt (line 1)) Requirement already satisfied: setuptools in /user_builds/extra-hed/envs/latest/lib/python3.4/site-packages (from sphinx>=1.8->-r /user_builds/extra-hed/checkouts/latest/docs/requirements.txt (line 1)) Requirement already satisfied: snowballstemmer>=1.1 in /user_builds/extra-hed/envs/latest/lib/python3.4/site-packages (from sphinx>=1.8->-r /user_builds/extra-hed/checkouts/latest/docs/requirements.txt (line 1)) Requirement already satisfied: traitlets in /user_builds/extra-hed/envs/latest/lib/python3.4/site-packages (from nbsphinx->-r /user_builds/extra-hed/checkouts/latest/docs/requirements.txt (line 3)) Requirement already satisfied: nbconvert!=5.4 in /user_builds/extra-hed/envs/latest/lib/python3.4/site-packages (from nbsphinx->-r /user_builds/extra-hed/checkouts/latest/docs/requirements.txt (line 3)) Requirement already satisfied: nbformat in /user_builds/extra-hed/envs/latest/lib/python3.4/site-packages (from nbsphinx->-r /user_builds/extra-hed/checkouts/latest/docs/requirements.txt (line 3)) Requirement already satisfied: ply in /user_builds/extra-hed/envs/latest/lib/python3.4/site-packages (from pandoc->-r /user_builds/extra-hed/checkouts/latest/docs/requirements.txt (line 4)) Requirement already satisfied: cycler>=0.10 in /user_builds/extra-hed/envs/latest/lib/python3.4/site-packages (from matplotlib->-r /user_builds/extra-hed/checkouts/latest/docs/requirements.txt (line 10)) Requirement already satisfied: pyparsing!=2.0.4,!=2.1.2,!=2.1.6,>=2.0.1 in /user_builds/extra-hed/envs/latest/lib/python3.4/site-packages (from matplotlib->-r /user_builds/extra-hed/checkouts/latest/docs/requirements.txt (line 10)) Requirement already satisfied: pytz in /user_builds/extra-hed/envs/latest/lib/python3.4/site-packages (from matplotlib->-r /user_builds/extra-hed/checkouts/latest/docs/requirements.txt (line 10)) Requirement already satisfied: kiwisolver>=1.0.1 in /user_builds/extra-hed/envs/latest/lib/python3.4/site-packages (from matplotlib->-r /user_builds/extra-hed/checkouts/latest/docs/requirements.txt (line 10)) Requirement already satisfied: python-dateutil>=2.1 in /user_builds/extra-hed/envs/latest/lib/python3.4/site-packages (from matplotlib->-r /user_builds/extra-hed/checkouts/latest/docs/requirements.txt (line 10)) Requirement already satisfied: MarkupSafe>=0.23 in /user_builds/extra-hed/envs/latest/lib/python3.4/site-packages (from Jinja2>=2.3->sphinx>=1.8->-r /user_builds/extra-hed/checkouts/latest/docs/requirements.txt (line 1)) Requirement already satisfied: idna<2.9,>=2.5 in /user_builds/extra-hed/envs/latest/lib/python3.4/site-packages (from requests>=2.0.0->sphinx>=1.8->-r /user_builds/extra-hed/checkouts/latest/docs/requirements.txt (line 1)) Requirement already satisfied: certifi>=2017.4.17 in /user_builds/extra-hed/envs/latest/lib/python3.4/site-packages (from requests>=2.0.0->sphinx>=1.8->-r /user_builds/extra-hed/checkouts/latest/docs/requirements.txt (line 1)) Requirement already satisfied: chardet<3.1.0,>=3.0.2 in /user_builds/extra-hed/envs/latest/lib/python3.4/site-packages (from requests>=2.0.0->sphinx>=1.8->-r /user_builds/extra-hed/checkouts/latest/docs/requirements.txt (line 1)) Requirement already satisfied: urllib3<1.25,>=1.21.1 in /user_builds/extra-hed/envs/latest/lib/python3.4/site-packages (from requests>=2.0.0->sphinx>=1.8->-r /user_builds/extra-hed/checkouts/latest/docs/requirements.txt (line 1)) Requirement already satisfied: ipython-genutils in /user_builds/extra-hed/envs/latest/lib/python3.4/site-packages (from traitlets->nbsphinx->-r /user_builds/extra-hed/checkouts/latest/docs/requirements.txt (line 3)) Requirement already satisfied: decorator in /user_builds/extra-hed/envs/latest/lib/python3.4/site-packages (from traitlets->nbsphinx->-r /user_builds/extra-hed/checkouts/latest/docs/requirements.txt (line 3)) Requirement already satisfied: mistune>=0.8.1 in /user_builds/extra-hed/envs/latest/lib/python3.4/site-packages (from nbconvert!=5.4->nbsphinx->-r /user_builds/extra-hed/checkouts/latest/docs/requirements.txt (line 3)) Requirement already satisfied: defusedxml in /user_builds/extra-hed/envs/latest/lib/python3.4/site-packages (from nbconvert!=5.4->nbsphinx->-r /user_builds/extra-hed/checkouts/latest/docs/requirements.txt (line 3)) Requirement already satisfied: testpath in /user_builds/extra-hed/envs/latest/lib/python3.4/site-packages (from nbconvert!=5.4->nbsphinx->-r /user_builds/extra-hed/checkouts/latest/docs/requirements.txt (line 3)) Requirement already satisfied: jupyter-core in /user_builds/extra-hed/envs/latest/lib/python3.4/site-packages (from nbconvert!=5.4->nbsphinx->-r /user_builds/extra-hed/checkouts/latest/docs/requirements.txt (line 3)) Requirement already satisfied: bleach in /user_builds/extra-hed/envs/latest/lib/python3.4/site-packages (from nbconvert!=5.4->nbsphinx->-r /user_builds/extra-hed/checkouts/latest/docs/requirements.txt (line 3)) Requirement already satisfied: entrypoints>=0.2.2 in /user_builds/extra-hed/envs/latest/lib/python3.4/site-packages (from nbconvert!=5.4->nbsphinx->-r /user_builds/extra-hed/checkouts/latest/docs/requirements.txt (line 3)) Requirement already satisfied: pandocfilters>=1.4.1 in /user_builds/extra-hed/envs/latest/lib/python3.4/site-packages (from nbconvert!=5.4->nbsphinx->-r /user_builds/extra-hed/checkouts/latest/docs/requirements.txt (line 3)) Requirement already satisfied: jsonschema!=2.5.0,>=2.4 in /user_builds/extra-hed/envs/latest/lib/python3.4/site-packages (from nbformat->nbsphinx->-r /user_builds/extra-hed/checkouts/latest/docs/requirements.txt (line 3)) Requirement already satisfied: webencodings in /user_builds/extra-hed/envs/latest/lib/python3.4/site-packages (from bleach->nbconvert!=5.4->nbsphinx->-r /user_builds/extra-hed/checkouts/latest/docs/requirements.txt (line 3)) Requirement already satisfied: attrs>=17.4.0 in /user_builds/extra-hed/envs/latest/lib/python3.4/site-packages (from jsonschema!=2.5.0,>=2.4->nbformat->nbsphinx->-r /user_builds/extra-hed/checkouts/latest/docs/requirements.txt (line 3)) Requirement already satisfied: pyrsistent>=0.14.0 in /user_builds/extra-hed/envs/latest/lib/python3.4/site-packages (from jsonschema!=2.5.0,>=2.4->nbformat->nbsphinx->-r /user_builds/extra-hed/checkouts/latest/docs/requirements.txt (line 3)) Requirement already satisfied: importlib-metadata; python_version < "3.8" in /user_builds/extra-hed/envs/latest/lib/python3.4/site-packages (from jsonschema!=2.5.0,>=2.4->nbformat->nbsphinx->-r /user_builds/extra-hed/checkouts/latest/docs/requirements.txt (line 3)) Requirement already satisfied: pathlib2; python_version == "3.4.*" or python_version < "3" in /user_builds/extra-hed/envs/latest/lib/python3.4/site-packages (from importlib-metadata; python_version < "3.8"->jsonschema!=2.5.0,>=2.4->nbformat->nbsphinx->-r /user_builds/extra-hed/checkouts/latest/docs/requirements.txt (line 3)) Requirement already satisfied: zipp>=0.5 in /user_builds/extra-hed/envs/latest/lib/python3.4/site-packages (from importlib-metadata; python_version < "3.8"->jsonschema!=2.5.0,>=2.4->nbformat->nbsphinx->-r /user_builds/extra-hed/checkouts/latest/docs/requirements.txt (line 3)) Requirement already satisfied: scandir; python_version < "3.5" in /user_builds/extra-hed/envs/latest/lib/python3.4/site-packages (from pathlib2; python_version == "3.4.*" or python_version < "3"->importlib-metadata; python_version < "3.8"->jsonschema!=2.5.0,>=2.4->nbformat->nbsphinx->-r /user_builds/extra-hed/checkouts/latest/docs/requirements.txt (line 3)) Installing collected packages: sphinx Found existing installation: Sphinx 1.3.5 Uninstalling Sphinx-1.3.5: Successfully uninstalled Sphinx-1.3.5 Successfully installed sphinx-1.8.5 You are using pip version 9.0.1, however version 20.2.2 is available. You should consider upgrading via the 'pip install --upgrade pip' command. [rtd-command-info] start-time: 2020-08-28T18:27:11.765000Z, end-time: 2020-08-28T18:27:11.783000Z, duration: 0, exit-code: 0 cat conf.py # -*- coding: utf-8 -*- # # Configuration file for the Sphinx documentation builder. # # This file does only contain a selection of the most common options. For a # full list see the documentation: # http://www.sphinx-doc.org/en/master/config # -- Path setup -------------------------------------------------------------- # If extensions (or modules to document with autodoc) are in another directory, # add these directories to sys.path here. If the directory is relative to the # documentation root, use os.path.abspath to make it absolute, like shown here. # import os # import sys # sys.path.insert(0, os.path.abspath('.')) # -- Project information ----------------------------------------------------- project = 'EXtra-HED' copyright = '2020, Thomas Michelat' author = 'Thomas Michelat' # The short X.Y version #import extra_hed #version = extra_hed.__version__ version = '0.1' # The full version, including alpha/beta/rc tags #release = version release = '0.1' # -- General configuration --------------------------------------------------- # If your documentation needs a minimal Sphinx version, state it here. # # needs_sphinx = '1.0' # Add any Sphinx extension module names here, as strings. They can be # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. extensions = [ 'sphinx.ext.autodoc', 'sphinx.ext.doctest', 'sphinx.ext.intersphinx', 'sphinx.ext.todo', 'sphinx.ext.coverage', 'sphinx.ext.mathjax', 'sphinx.ext.ifconfig', 'sphinx.ext.viewcode', 'nbsphinx', 'sphinx_rtd_theme', ] # Add any paths that contain templates here, relative to this directory. templates_path = ['_templates'] # The suffix(es) of source filenames. # You can specify multiple suffix as a list of string: # # source_suffix = ['.rst', '.md'] source_suffix = '.rst' # The master toctree document. master_doc = 'index' # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. # # This is also used if you do content translation via gettext catalogs. # Usually you set "language" from the command line for these cases. language = None # List of patterns, relative to source directory, that match files and # directories to ignore when looking for source files. # This pattern also affects html_static_path and html_extra_path. exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store'] # The name of the Pygments (syntax highlighting) style to use. pygments_style = 'sphinx' on_rtd = os.environ.get('READTHEDOCS') == 'True' if on_rtd: tags.add('readthedocs') # -- Options for HTML output ------------------------------------------------- # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. # html_theme = 'sphinx_rtd_theme' # Theme options are theme-specific and customize the look and feel of a theme # further. For a list of options available for each theme, see the # documentation. # # html_theme_options = {} # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files, # so a file named "default.css" will overwrite the builtin "default.css". html_static_path = ['_static'] # Custom sidebar templates, must be a dictionary that maps document names # to template names. # # The default sidebars (for documents that don't match any pattern) are # defined by theme itself. Builtin themes are using these templates by # default: ``['localtoc.html', 'relations.html', 'sourcelink.html', # 'searchbox.html']``. # # html_sidebars = {} # -- Options for HTMLHelp output --------------------------------------------- # Output file base name for HTML help builder. htmlhelp_basename = 'EXtra-HEDdoc' # -- Options for LaTeX output ------------------------------------------------ latex_elements = { # The paper size ('letterpaper' or 'a4paper'). # # 'papersize': 'letterpaper', # The font size ('10pt', '11pt' or '12pt'). # # 'pointsize': '10pt', # Additional stuff for the LaTeX preamble. # # 'preamble': '', # Latex figure (float) alignment # # 'figure_align': 'htbp', } # Grouping the document tree into LaTeX files. List of tuples # (source start file, target name, title, # author, documentclass [howto, manual, or own class]). latex_documents = [ (master_doc, 'EXtra-HED.tex', 'EXtra-HED Documentation', 'Thomas Michelat', 'manual'), ] # -- Options for manual page output ------------------------------------------ # One entry per manual page. List of tuples # (source start file, name, description, authors, manual section). man_pages = [ (master_doc, 'extra-hed', 'EXtra-HED Documentation', [author], 1) ] # -- Options for Texinfo output ---------------------------------------------- # Grouping the document tree into Texinfo files. List of tuples # (source start file, target name, title, author, # dir menu entry, description, category) texinfo_documents = [ (master_doc, 'EXtra-HED', 'EXtra-HED Documentation', author, 'EXtra-HED', 'One line description of project.', 'Miscellaneous'), ] # -- Options for Epub output ------------------------------------------------- # Bibliographic Dublin Core info. epub_title = project # The unique identifier of the text. This can be a ISBN number # or the project homepage. # # epub_identifier = '' # A unique identification for the text. # # epub_uid = '' # A list of files that should not be packed into the epub file. epub_exclude_files = ['search.html'] # -- Extension configuration ------------------------------------------------- # -- Options for intersphinx extension --------------------------------------- # Example configuration for intersphinx: refer to the Python standard library. intersphinx_mapping = { 'python': ('http://docs.python.org/', None), 'extra-data': ('https://extra-data.readthedocs.io/en/latest/', None) } # -- Options for todo extension ---------------------------------------------- # If true, `todo` and `todoList` produce output, else they produce nothing. todo_include_todos = False ########################################################################### # 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 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 else: SUFFIX = source_suffix[0] 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') html_static_path.append('/rtd_root/readthedocs/templates/sphinx/_static') # Add RTD Theme only if they aren't overriding it already using_rtd_theme = False if 'html_theme' in globals(): if html_theme in ['default']: # Allow people to bail with a hack of having an html_style if not 'html_style' in globals(): import sphinx_rtd_theme html_theme = 'sphinx_rtd_theme' html_style = None html_theme_options = {} if 'html_theme_path' in globals(): html_theme_path.append(sphinx_rtd_theme.get_html_theme_path()) else: html_theme_path = [sphinx_rtd_theme.get_html_theme_path()] using_rtd_theme = True else: import sphinx_rtd_theme html_theme = 'sphinx_rtd_theme' html_style = None html_theme_options = {} if 'html_theme_path' in globals(): html_theme_path.append(sphinx_rtd_theme.get_html_theme_path()) else: html_theme_path = [sphinx_rtd_theme.get_html_theme_path()] using_rtd_theme = True if globals().get('websupport2_base_url', False): websupport2_base_url = 'https://readthedocs.org/websupport' if 'http' not in settings.MEDIA_URL: websupport2_static_url = '/static/' else: websupport2_static_url = '/media//static' #Add project information to the template context. context = { 'using_theme': using_rtd_theme, 'html_theme': html_theme, 'current_version': "latest", 'MEDIA_URL': "/media/", 'PRODUCTION_DOMAIN': "exflrtd.desy.de", 'versions': [ ("latest", "/en/latest/"), ("stable", "/en/stable/"), ], 'downloads': [ ], 'subprojects': [ ], 'slug': 'extra-hed', 'name': u'EXtra-HED', 'rtd_language': u'en', 'canonical_url': 'http://exflrtd.desy.de/docs/extra-hed/en/latest/', 'analytics_code': '', 'single_version': False, 'conf_py_path': '/docs/', 'api_host': 'https://readthedocs.org', 'github_user': 'None', 'github_repo': 'None', 'github_version': 'master', 'display_github': False, 'bitbucket_user': 'None', 'bitbucket_repo': 'None', 'bitbucket_version': 'master', 'display_bitbucket': False, 'READTHEDOCS': True, 'using_theme': (html_theme == "default"), 'new_theme': (html_theme == "sphinx_rtd_theme"), 'source_suffix': SUFFIX, 'user_analytics_code': '', 'global_analytics_code': 'UA-17997319-1', 'commit': '207ca9d1', } if 'html_context' in globals(): html_context.update(context) else: html_context = context # Add custom RTD extension if 'extensions' in globals(): extensions.append("readthedocs_ext.readthedocs") else: extensions = ["readthedocs_ext.readthedocs"] [rtd-command-info] start-time: 2020-08-28T18:27:11.854000Z, end-time: 2020-08-28T18:27:23.207000Z, duration: 11, exit-code: 2 python /user_builds/extra-hed/envs/latest/bin/sphinx-build -T -E -b readthedocs -d _build/doctrees-readthedocs -D language=en . _build/html Running Sphinx v1.8.5 loading translations [en]... done WARNING: extension 'sphinx_rtd_theme' has no setup() function; is it really a Sphinx extension module? making output directory... loading intersphinx inventory from https://extra-data.readthedocs.io/en/latest/objects.inv... loading intersphinx inventory from http://docs.python.org/objects.inv... intersphinx inventory has moved: http://docs.python.org/objects.inv -> https://docs.python.org/3/objects.inv building [mo]: targets for 0 po files that are out of date building [readthedocs]: targets for 5 source files that are out of date updating environment: 5 added, 0 changed, 0 removed reading sources... [ 20%] accessing_data reading sources... [ 40%] changelog reading sources... [ 60%] index reading sources... [ 80%] math reading sources... [100%] tutorial /user_builds/extra-hed/envs/latest/lib/python3.4/site-packages/sphinx/websupport/__init__.py:25: RemovedInSphinx20Warning: sphinx.websupport module is now provided as sphinxcontrib-websupport. sphinx.websupport will be removed at Sphinx-2.0. Please use the package instead. RemovedInSphinx20Warning) WARNING: autodoc: failed to import method 'Proposal.__init__' from module 'extra_hed'; the following exception was raised: No module named 'extra_hed' WARNING: autodoc: failed to import method 'Proposal.run' from module 'extra_hed'; the following exception was raised: No module named 'extra_hed' WARNING: autodoc: failed to import method 'Run.__init__' from module 'extra_hed'; the following exception was raised: No module named 'extra_hed' WARNING: autodoc: failed to import attribute 'Run.devices' from module 'extra_hed'; the following exception was raised: No module named 'extra_hed' WARNING: autodoc: failed to import method 'Run.get' from module 'extra_hed'; the following exception was raised: No module named 'extra_hed' WARNING: autodoc: failed to import method 'Run.union' from module 'extra_hed'; the following exception was raised: No module named 'extra_hed' WARNING: autodoc: failed to import attribute 'instrument.Device.control_keys' from module 'extra_hed'; the following exception was raised: No module named 'extra_hed' WARNING: autodoc: failed to import attribute 'instrument.Device.channels' from module 'extra_hed'; the following exception was raised: No module named 'extra_hed' WARNING: autodoc: failed to import attribute 'instrument.Device.instrument_keys' from module 'extra_hed'; the following exception was raised: No module named 'extra_hed' WARNING: autodoc: failed to import method 'instrument.Detector.mean' from module 'extra_hed'; the following exception was raised: No module named 'extra_hed' WARNING: autodoc: failed to import class 'instrument.XGM' from module 'extra_hed'; the following exception was raised: No module named 'extra_hed' WARNING: autodoc: failed to import class 'instrument.ADC' from module 'extra_hed'; the following exception was raised: No module named 'extra_hed' WARNING: autodoc: failed to import class 'instrument.Detector' from module 'extra_hed'; the following exception was raised: No module named 'extra_hed' WARNING: autodoc: failed to import class 'instrument.Camera' from module 'extra_hed'; the following exception was raised: No module named 'extra_hed' WARNING: autodoc: failed to import class 'instrument.EPIX10K' from module 'extra_hed'; the following exception was raised: No module named 'extra_hed' WARNING: autodoc: failed to import class 'instrument.EPIX100' from module 'extra_hed'; the following exception was raised: No module named 'extra_hed' WARNING: autodoc: failed to import class 'instrument.JUNGFRAU' from module 'extra_hed'; the following exception was raised: No module named 'extra_hed' WARNING: autodoc: failed to import module 'keydata' from module 'extra_data'; the following exception was raised: No module named 'extra_data' WARNING: autodoc: failed to import module 'math' from module 'extra_hed'; the following exception was raised: No module named 'extra_hed' Traceback (most recent call last): File "/user_builds/extra-hed/envs/latest/lib/python3.4/site-packages/nbsphinx.py", line 994, in parse rststring, resources = exporter.from_notebook_node(nb, resources) File "/user_builds/extra-hed/envs/latest/lib/python3.4/site-packages/nbsphinx.py", line 813, in from_notebook_node nb, resources, **kw) File "/user_builds/extra-hed/envs/latest/lib/python3.4/site-packages/nbconvert/exporters/templateexporter.py", line 315, in from_notebook_node output = self.template.render(nb=nb_copy, resources=resources) File "/user_builds/extra-hed/envs/latest/lib/python3.4/site-packages/jinja2/environment.py", line 1008, in render return self.environment.handle_exception(exc_info, True) File "/user_builds/extra-hed/envs/latest/lib/python3.4/site-packages/jinja2/environment.py", line 780, in handle_exception reraise(exc_type, exc_value, tb) File "/user_builds/extra-hed/envs/latest/lib/python3.4/site-packages/jinja2/_compat.py", line 37, in reraise raise value.with_traceback(tb) File "