Read the Docs build information Build id: 22537 Project: tzpgcalc Version: rtd-build Commit: 70cbb5bb671ae36973277915496a15908744781c Date: 2021-10-04T12:32:17.797053Z State: finished Success: False [rtd-command-info] start-time: 2021-10-04T12:32:18.927330Z, end-time: 2021-10-04T12:32:19.515965Z, duration: 0, exit-code: 0 git clone --no-single-branch --depth 50 https://git.xfel.eu/SCS/tzpgcalc . Cloning into '.'... warning: redirecting to https://git.xfel.eu/SCS/tzpgcalc.git/ [rtd-command-info] start-time: 2021-10-04T12:32:19.891845Z, end-time: 2021-10-04T12:32:20.137611Z, duration: 0, exit-code: 0 git checkout --force origin/rtd-build Note: checking out 'origin/rtd-build'. 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 70cbb5b Add requirements.txt [rtd-command-info] start-time: 2021-10-04T12:32:20.268784Z, end-time: 2021-10-04T12:32:20.348319Z, duration: 0, exit-code: 0 git clean -d -f -f [rtd-command-info] start-time: 2021-10-04T12:32:21.481894Z, end-time: 2021-10-04T12:32:26.633395Z, duration: 5, exit-code: 0 python3.7 -mvirtualenv /usr/src/app/checkouts/readthedocs.org/user_builds/tzpgcalc/envs/rtd-build Using base prefix '/home/docs/.pyenv/versions/3.7.3' New python executable in /usr/src/app/checkouts/readthedocs.org/user_builds/tzpgcalc/envs/rtd-build/bin/python3.7 Also creating executable in /usr/src/app/checkouts/readthedocs.org/user_builds/tzpgcalc/envs/rtd-build/bin/python Installing setuptools, pip, wheel... done. [rtd-command-info] start-time: 2021-10-04T12:32:26.776783Z, end-time: 2021-10-04T12:32:27.742502Z, duration: 0, exit-code: 0 /usr/src/app/checkouts/readthedocs.org/user_builds/tzpgcalc/envs/rtd-build/bin/python -m pip install --upgrade --no-cache-dir pip Requirement already satisfied: pip in /usr/src/app/checkouts/readthedocs.org/user_builds/tzpgcalc/envs/rtd-build/lib/python3.7/site-packages (21.2.4) [rtd-command-info] start-time: 2021-10-04T12:32:27.875050Z, end-time: 2021-10-04T12:32:39.214707Z, duration: 11, exit-code: 0 /usr/src/app/checkouts/readthedocs.org/user_builds/tzpgcalc/envs/rtd-build/bin/python -m pip install --upgrade --no-cache-dir 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.zip (861 kB) Collecting pillow==5.4.1 Downloading Pillow-5.4.1-cp37-cp37m-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.4-py2.py3-none-any.whl (28 kB) Collecting future Downloading future-0.18.2.tar.gz (829 kB) Collecting babel!=2.0,>=1.3 Downloading Babel-2.9.1-py2.py3-none-any.whl (8.8 MB) Collecting Jinja2>=2.3 Downloading Jinja2-3.0.1-py3-none-any.whl (133 kB) Collecting snowballstemmer>=1.1 Downloading snowballstemmer-2.1.0-py2.py3-none-any.whl (93 kB) Collecting imagesize Downloading imagesize-1.2.0-py2.py3-none-any.whl (4.8 kB) Collecting packaging Downloading packaging-21.0-py3-none-any.whl (40 kB) Collecting sphinxcontrib-websupport Downloading sphinxcontrib_websupport-1.2.4-py2.py3-none-any.whl (39 kB) Collecting six>=1.5 Downloading six-1.16.0-py2.py3-none-any.whl (11 kB) Collecting requests>=2.0.0 Downloading requests-2.26.0-py2.py3-none-any.whl (62 kB) Collecting pytz>=2015.7 Downloading pytz-2021.3-py2.py3-none-any.whl (503 kB) Collecting MarkupSafe>=2.0 Downloading MarkupSafe-2.0.1-cp37-cp37m-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_12_x86_64.manylinux2010_x86_64.whl (31 kB) Collecting charset-normalizer~=2.0.0 Downloading charset_normalizer-2.0.6-py3-none-any.whl (37 kB) Collecting urllib3<1.27,>=1.21.1 Downloading urllib3-1.26.7-py2.py3-none-any.whl (138 kB) Collecting certifi>=2017.4.17 Downloading certifi-2021.5.30-py2.py3-none-any.whl (145 kB) Collecting idna<4,>=2.5 Downloading idna-3.2-py3-none-any.whl (59 kB) Collecting pyparsing>=2.0.2 Downloading pyparsing-2.4.7-py2.py3-none-any.whl (67 kB) Collecting sphinxcontrib-serializinghtml Downloading sphinxcontrib_serializinghtml-1.1.5-py2.py3-none-any.whl (94 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=23772 sha256=b24edf18a45134f1911380f6bb5c455197ac47ccb7aacb57c59768e7daff125d Stored in directory: /tmp/pip-ephem-wheel-cache-lgikavul/wheels/7a/94/b1/0fdc5339a5bd487a5cc15421ec200d9ba3e2aa7190e4a727f1 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=491070 sha256=af5fd705b75182ee29811be73ffa75ca08fcb19513ef35755cb14fcfeb903bd5 Stored in directory: /tmp/pip-ephem-wheel-cache-lgikavul/wheels/56/b0/fe/4410d17b32f1f0c3cf54cdfb2bc04d7b4b8f4ae377e2229ba0 Successfully built mock future Installing collected packages: urllib3, sphinxcontrib-serializinghtml, pytz, pyparsing, MarkupSafe, idna, charset-normalizer, 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 58.2.0 Uninstalling setuptools-58.2.0: Successfully uninstalled setuptools-58.2.0 Successfully installed Jinja2-3.0.1 MarkupSafe-2.0.1 Pygments-2.3.1 alabaster-0.7.12 babel-2.9.1 certifi-2021.5.30 charset-normalizer-2.0.6 commonmark-0.8.1 docutils-0.14 future-0.18.2 idna-3.2 imagesize-1.2.0 mock-1.0.1 packaging-21.0 pillow-5.4.1 pyparsing-2.4.7 pytz-2021.3 readthedocs-sphinx-ext-1.0.4 recommonmark-0.5.0 requests-2.26.0 setuptools-41.0.1 six-1.16.0 snowballstemmer-2.1.0 sphinx-1.8.5 sphinx-rtd-theme-0.4.3 sphinxcontrib-serializinghtml-1.1.5 sphinxcontrib-websupport-1.2.4 urllib3-1.26.7 [rtd-command-info] start-time: 2021-10-04T12:32:39.348232Z, end-time: 2021-10-04T12:32:46.469957Z, duration: 7, exit-code: 0 /usr/src/app/checkouts/readthedocs.org/user_builds/tzpgcalc/envs/rtd-build/bin/python -m pip install --exists-action=w --no-cache-dir -r doc/requirements.txt Requirement already satisfied: sphinx in /usr/src/app/checkouts/readthedocs.org/user_builds/tzpgcalc/envs/rtd-build/lib/python3.7/site-packages (from -r doc/requirements.txt (line 1)) (1.8.5) Requirement already satisfied: sphinx_rtd_theme in /usr/src/app/checkouts/readthedocs.org/user_builds/tzpgcalc/envs/rtd-build/lib/python3.7/site-packages (from -r doc/requirements.txt (line 2)) (0.4.3) Collecting nbsphinx Downloading nbsphinx-0.8.7-py3-none-any.whl (25 kB) Requirement already satisfied: babel!=2.0,>=1.3 in /usr/src/app/checkouts/readthedocs.org/user_builds/tzpgcalc/envs/rtd-build/lib/python3.7/site-packages (from sphinx->-r doc/requirements.txt (line 1)) (2.9.1) Requirement already satisfied: Pygments>=2.0 in /usr/src/app/checkouts/readthedocs.org/user_builds/tzpgcalc/envs/rtd-build/lib/python3.7/site-packages (from sphinx->-r doc/requirements.txt (line 1)) (2.3.1) Requirement already satisfied: imagesize in /usr/src/app/checkouts/readthedocs.org/user_builds/tzpgcalc/envs/rtd-build/lib/python3.7/site-packages (from sphinx->-r doc/requirements.txt (line 1)) (1.2.0) Requirement already satisfied: six>=1.5 in /usr/src/app/checkouts/readthedocs.org/user_builds/tzpgcalc/envs/rtd-build/lib/python3.7/site-packages (from sphinx->-r doc/requirements.txt (line 1)) (1.16.0) Requirement already satisfied: Jinja2>=2.3 in /usr/src/app/checkouts/readthedocs.org/user_builds/tzpgcalc/envs/rtd-build/lib/python3.7/site-packages (from sphinx->-r doc/requirements.txt (line 1)) (3.0.1) Requirement already satisfied: docutils>=0.11 in /usr/src/app/checkouts/readthedocs.org/user_builds/tzpgcalc/envs/rtd-build/lib/python3.7/site-packages (from sphinx->-r doc/requirements.txt (line 1)) (0.14) Requirement already satisfied: snowballstemmer>=1.1 in /usr/src/app/checkouts/readthedocs.org/user_builds/tzpgcalc/envs/rtd-build/lib/python3.7/site-packages (from sphinx->-r doc/requirements.txt (line 1)) (2.1.0) Requirement already satisfied: alabaster<0.8,>=0.7 in /usr/src/app/checkouts/readthedocs.org/user_builds/tzpgcalc/envs/rtd-build/lib/python3.7/site-packages (from sphinx->-r doc/requirements.txt (line 1)) (0.7.12) Requirement already satisfied: setuptools in /usr/src/app/checkouts/readthedocs.org/user_builds/tzpgcalc/envs/rtd-build/lib/python3.7/site-packages (from sphinx->-r doc/requirements.txt (line 1)) (41.0.1) Requirement already satisfied: requests>=2.0.0 in /usr/src/app/checkouts/readthedocs.org/user_builds/tzpgcalc/envs/rtd-build/lib/python3.7/site-packages (from sphinx->-r doc/requirements.txt (line 1)) (2.26.0) Requirement already satisfied: sphinxcontrib-websupport in /usr/src/app/checkouts/readthedocs.org/user_builds/tzpgcalc/envs/rtd-build/lib/python3.7/site-packages (from sphinx->-r doc/requirements.txt (line 1)) (1.2.4) Requirement already satisfied: packaging in /usr/src/app/checkouts/readthedocs.org/user_builds/tzpgcalc/envs/rtd-build/lib/python3.7/site-packages (from sphinx->-r doc/requirements.txt (line 1)) (21.0) Collecting traitlets Downloading traitlets-5.1.0-py3-none-any.whl (101 kB) Collecting nbformat Downloading nbformat-5.1.3-py3-none-any.whl (178 kB) Collecting nbconvert!=5.4 Downloading nbconvert-6.2.0-py3-none-any.whl (553 kB) Requirement already satisfied: pytz>=2015.7 in /usr/src/app/checkouts/readthedocs.org/user_builds/tzpgcalc/envs/rtd-build/lib/python3.7/site-packages (from babel!=2.0,>=1.3->sphinx->-r doc/requirements.txt (line 1)) (2021.3) Requirement already satisfied: MarkupSafe>=2.0 in /usr/src/app/checkouts/readthedocs.org/user_builds/tzpgcalc/envs/rtd-build/lib/python3.7/site-packages (from Jinja2>=2.3->sphinx->-r doc/requirements.txt (line 1)) (2.0.1) Collecting jupyter-core Downloading jupyter_core-4.8.1-py3-none-any.whl (86 kB) Collecting mistune<2,>=0.8.1 Downloading mistune-0.8.4-py2.py3-none-any.whl (16 kB) Collecting bleach Downloading bleach-4.1.0-py2.py3-none-any.whl (157 kB) Collecting entrypoints>=0.2.2 Downloading entrypoints-0.3-py2.py3-none-any.whl (11 kB) Collecting Pygments>=2.0 Downloading Pygments-2.10.0-py3-none-any.whl (1.0 MB) Collecting defusedxml Downloading defusedxml-0.7.1-py2.py3-none-any.whl (25 kB) Collecting jupyterlab-pygments Downloading jupyterlab_pygments-0.1.2-py2.py3-none-any.whl (4.6 kB) Collecting nbclient<0.6.0,>=0.5.0 Downloading nbclient-0.5.4-py3-none-any.whl (66 kB) Collecting pandocfilters>=1.4.1 Downloading pandocfilters-1.5.0-py2.py3-none-any.whl (8.7 kB) Collecting testpath Downloading testpath-0.5.0-py3-none-any.whl (84 kB) Collecting jupyter-client>=6.1.5 Downloading jupyter_client-7.0.5-py3-none-any.whl (124 kB) Collecting nest-asyncio Downloading nest_asyncio-1.5.1-py3-none-any.whl (5.0 kB) Collecting tornado>=4.1 Downloading tornado-6.1-cp37-cp37m-manylinux2010_x86_64.whl (428 kB) Collecting python-dateutil>=2.1 Downloading python_dateutil-2.8.2-py2.py3-none-any.whl (247 kB) Collecting pyzmq>=13 Downloading pyzmq-22.3.0-cp37-cp37m-manylinux_2_5_x86_64.manylinux1_x86_64.whl (1.1 MB) Collecting jsonschema!=2.5.0,>=2.4 Downloading jsonschema-4.0.1-py3-none-any.whl (69 kB) Collecting ipython-genutils Downloading ipython_genutils-0.2.0-py2.py3-none-any.whl (26 kB) Collecting pyrsistent!=0.17.0,!=0.17.1,!=0.17.2,>=0.14.0 Downloading pyrsistent-0.18.0-cp37-cp37m-manylinux1_x86_64.whl (119 kB) Collecting importlib-metadata Downloading importlib_metadata-4.8.1-py3-none-any.whl (17 kB) Collecting attrs>=17.4.0 Downloading attrs-21.2.0-py2.py3-none-any.whl (53 kB) Requirement already satisfied: certifi>=2017.4.17 in /usr/src/app/checkouts/readthedocs.org/user_builds/tzpgcalc/envs/rtd-build/lib/python3.7/site-packages (from requests>=2.0.0->sphinx->-r doc/requirements.txt (line 1)) (2021.5.30) Requirement already satisfied: charset-normalizer~=2.0.0 in /usr/src/app/checkouts/readthedocs.org/user_builds/tzpgcalc/envs/rtd-build/lib/python3.7/site-packages (from requests>=2.0.0->sphinx->-r doc/requirements.txt (line 1)) (2.0.6) Requirement already satisfied: urllib3<1.27,>=1.21.1 in /usr/src/app/checkouts/readthedocs.org/user_builds/tzpgcalc/envs/rtd-build/lib/python3.7/site-packages (from requests>=2.0.0->sphinx->-r doc/requirements.txt (line 1)) (1.26.7) Requirement already satisfied: idna<4,>=2.5 in /usr/src/app/checkouts/readthedocs.org/user_builds/tzpgcalc/envs/rtd-build/lib/python3.7/site-packages (from requests>=2.0.0->sphinx->-r doc/requirements.txt (line 1)) (3.2) Collecting webencodings Downloading webencodings-0.5.1-py2.py3-none-any.whl (11 kB) Collecting typing-extensions>=3.6.4 Downloading typing_extensions-3.10.0.2-py3-none-any.whl (26 kB) Collecting zipp>=0.5 Downloading zipp-3.6.0-py3-none-any.whl (5.3 kB) Requirement already satisfied: pyparsing>=2.0.2 in /usr/src/app/checkouts/readthedocs.org/user_builds/tzpgcalc/envs/rtd-build/lib/python3.7/site-packages (from packaging->sphinx->-r doc/requirements.txt (line 1)) (2.4.7) Requirement already satisfied: sphinxcontrib-serializinghtml in /usr/src/app/checkouts/readthedocs.org/user_builds/tzpgcalc/envs/rtd-build/lib/python3.7/site-packages (from sphinxcontrib-websupport->sphinx->-r doc/requirements.txt (line 1)) (1.1.5) Installing collected packages: zipp, typing-extensions, traitlets, pyrsistent, importlib-metadata, attrs, tornado, pyzmq, python-dateutil, nest-asyncio, jupyter-core, jsonschema, ipython-genutils, entrypoints, webencodings, Pygments, nbformat, jupyter-client, testpath, pandocfilters, nbclient, mistune, jupyterlab-pygments, defusedxml, bleach, nbconvert, nbsphinx Attempting uninstall: Pygments Found existing installation: Pygments 2.3.1 Uninstalling Pygments-2.3.1: Successfully uninstalled Pygments-2.3.1 Successfully installed Pygments-2.10.0 attrs-21.2.0 bleach-4.1.0 defusedxml-0.7.1 entrypoints-0.3 importlib-metadata-4.8.1 ipython-genutils-0.2.0 jsonschema-4.0.1 jupyter-client-7.0.5 jupyter-core-4.8.1 jupyterlab-pygments-0.1.2 mistune-0.8.4 nbclient-0.5.4 nbconvert-6.2.0 nbformat-5.1.3 nbsphinx-0.8.7 nest-asyncio-1.5.1 pandocfilters-1.5.0 pyrsistent-0.18.0 python-dateutil-2.8.2 pyzmq-22.3.0 testpath-0.5.0 tornado-6.1 traitlets-5.1.0 typing-extensions-3.10.0.2 webencodings-0.5.1 zipp-3.6.0 [rtd-command-info] start-time: 2021-10-04T12:32:47.528662Z, end-time: 2021-10-04T12:32:47.609979Z, duration: 0, exit-code: 0 cat doc/source/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 = 'TZPG calculator' copyright = '2021, Loïc Le Guyader' author = 'Loïc Le Guyader' # The short X.Y version version = '' # The full version, including alpha/beta/rc tags release = '' # -- 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.mathjax', 'sphinx_rtd_theme', 'nbsphinx', 'jupyter_sphinx.execute' ] # 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 = [] # The name of the Pygments (syntax highlighting) style to use. pygments_style = None # -- 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 = 'alabaster' 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 = 'TZPGcalculatordoc' # -- 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, 'TZPGcalculator.tex', 'TZPG calculator Documentation', 'Loïc Le Guyader', '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, 'tzpgcalculator', 'TZPG calculator 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, 'TZPGcalculator', 'TZPG calculator Documentation', author, 'TZPGcalculator', '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 ------------------------------------------------- ########################################################################### # 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 = 'http://rtd.xfel.eu/websupport' websupport2_static_url = '/static/' #Add project information to the template context. context = { 'using_theme': using_rtd_theme, 'html_theme': html_theme, 'current_version': "rtd-build", 'version_slug': "rtd-build", 'MEDIA_URL': "media/", 'STATIC_URL': "/static/", 'PRODUCTION_DOMAIN': "rtd.xfel.eu", 'versions': [ ("latest", "/en/latest/"), ("rtd-build", "/en/rtd-build/"), ], 'downloads': [ ], 'subprojects': [ ], 'slug': 'tzpgcalc', 'name': u'TZPGcalc', 'rtd_language': u'en', 'programming_language': u'words', 'canonical_url': 'http://rtd.xfel.eu/docs/tzpgcalc/en/latest/', 'analytics_code': 'None', 'single_version': False, 'conf_py_path': '/doc/source/', 'api_host': 'http://rtd.xfel.eu', 'github_user': 'None', 'proxied_api_host': '/_', 'github_repo': 'None', 'github_version': 'rtd-build', 'display_github': False, 'bitbucket_user': 'None', 'bitbucket_repo': 'None', 'bitbucket_version': 'rtd-build', 'display_bitbucket': False, 'gitlab_user': 'None', 'gitlab_repo': 'None', 'gitlab_version': 'rtd-build', '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': 'None', 'commit': '70cbb5bb', } 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: 2021-10-04T12:32:47.745040Z, end-time: 2021-10-04T12:32:48.853468Z, duration: 1, exit-code: 2 python /usr/src/app/checkouts/readthedocs.org/user_builds/tzpgcalc/envs/rtd-build/bin/sphinx-build -T -b readthedocs -d _build/doctrees-readthedocs -D language=en . _build/html Running Sphinx v1.8.5 loading translations [en]... done Traceback (most recent call last): File "/usr/src/app/checkouts/readthedocs.org/user_builds/tzpgcalc/envs/rtd-build/lib/python3.7/site-packages/sphinx/registry.py", line 472, in load_extension mod = __import__(extname, None, None, ['setup']) ModuleNotFoundError: No module named 'jupyter_sphinx' During handling of the above exception, another exception occurred: Traceback (most recent call last): File "/usr/src/app/checkouts/readthedocs.org/user_builds/tzpgcalc/envs/rtd-build/lib/python3.7/site-packages/sphinx/cmd/build.py", line 303, in build_main args.tags, args.verbosity, args.jobs, args.keep_going) File "/usr/src/app/checkouts/readthedocs.org/user_builds/tzpgcalc/envs/rtd-build/lib/python3.7/site-packages/sphinx/application.py", line 228, in __init__ self.setup_extension(extension) File "/usr/src/app/checkouts/readthedocs.org/user_builds/tzpgcalc/envs/rtd-build/lib/python3.7/site-packages/sphinx/application.py", line 449, in setup_extension self.registry.load_extension(self, extname) File "/usr/src/app/checkouts/readthedocs.org/user_builds/tzpgcalc/envs/rtd-build/lib/python3.7/site-packages/sphinx/registry.py", line 475, in load_extension raise ExtensionError(__('Could not import extension %s') % extname, err) sphinx.errors.ExtensionError: Could not import extension jupyter_sphinx.execute (exception: No module named 'jupyter_sphinx') Extension error: Could not import extension jupyter_sphinx.execute (exception: No module named 'jupyter_sphinx')