Read the Docs build information
Build id: 1172032
Project: nvidia-nemo
Version: main
Commit: b8cc5030d4cb95a7e3ce7a8c22ef9d736c5c0bfc
Date: 2022-11-07T21:18:28.126961Z
State: finished
Success: False


[rtd-command-info] start-time: 2022-11-07T21:18:35.762641Z, end-time: 2022-11-07T21:19:08.130319Z, duration: 32, exit-code: 0
git clone --no-single-branch --depth 50 https://github.com/NVIDIA/NeMo.git .
Cloning into '.'...

[rtd-command-info] start-time: 2022-11-07T21:19:08.376694Z, end-time: 2022-11-07T21:19:08.635338Z, duration: 0, exit-code: 0
git checkout --force origin/main
Note: switching to 'origin/main'.

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 switching back to a branch.

If you want to create a new branch to retain commits you create, you may
do so (now or later) by using -c with the switch command. Example:

  git switch -c <new-branch-name>

Or undo this operation with:

  git switch -

Turn off this advice by setting config variable advice.detachedHead to false

HEAD is now at b8cc5030d [STT] Add Ru ASR Conformer-CTC and Conformer-Transducer (#5340) (#5341)

[rtd-command-info] start-time: 2022-11-07T21:19:08.852407Z, end-time: 2022-11-07T21:19:08.936390Z, duration: 0, exit-code: 0
git clean -d -f -f


[rtd-command-info] start-time: 2022-11-07T21:19:10.077326Z, end-time: 2022-11-07T21:19:14.640012Z, duration: 4, exit-code: 0
python3.7 -mvirtualenv 
Using base prefix '/home/docs/.pyenv/versions/3.7.9'
New python executable in /home/docs/checkouts/readthedocs.org/user_builds/nvidia-nemo/envs/main/bin/python3.7
Also creating executable in /home/docs/checkouts/readthedocs.org/user_builds/nvidia-nemo/envs/main/bin/python
Installing setuptools, pip, wheel...
done.

[rtd-command-info] start-time: 2022-11-07T21:19:14.825311Z, end-time: 2022-11-07T21:19:16.597981Z, duration: 1, exit-code: 0
python -m pip install --upgrade --no-cache-dir pip setuptools<58.3.0
Requirement already satisfied: pip in /home/docs/checkouts/readthedocs.org/user_builds/nvidia-nemo/envs/main/lib/python3.7/site-packages (22.3.1)
Collecting setuptools<58.3.0
  Downloading setuptools-58.2.0-py3-none-any.whl (946 kB)
     ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 946.1/946.1 kB 24.0 MB/s eta 0:00:00
Installing collected packages: setuptools
  Attempting uninstall: setuptools
    Found existing installation: setuptools 65.5.1
    Uninstalling setuptools-65.5.1:
      Successfully uninstalled setuptools-65.5.1
Successfully installed setuptools-58.2.0

[rtd-command-info] start-time: 2022-11-07T21:19:16.943394Z, end-time: 2022-11-07T21:19:23.500390Z, duration: 6, exit-code: 0
python -m pip install --upgrade --no-cache-dir pillow==5.4.1 mock==1.0.1 alabaster>=0.7,<0.8,!=0.7.5 commonmark==0.9.1 recommonmark==0.5.0 sphinx<2 sphinx-rtd-theme<0.5 readthedocs-sphinx-ext<2.2 jinja2<3.1.0
Collecting pillow==5.4.1
  Downloading Pillow-5.4.1-cp37-cp37m-manylinux1_x86_64.whl (2.0 MB)
     ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 2.0/2.0 MB 43.5 MB/s eta 0:00:00
Collecting mock==1.0.1
  Downloading mock-1.0.1.zip (861 kB)
     ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 861.9/861.9 kB 258.5 MB/s eta 0:00:00
  Preparing metadata (setup.py): started
  Preparing metadata (setup.py): finished with status 'done'
Collecting alabaster!=0.7.5,<0.8,>=0.7
  Downloading alabaster-0.7.12-py2.py3-none-any.whl (14 kB)
Collecting commonmark==0.9.1
  Downloading commonmark-0.9.1-py2.py3-none-any.whl (51 kB)
     ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 51.1/51.1 kB 191.8 MB/s eta 0:00:00
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.6-py2.py3-none-any.whl (3.1 MB)
     ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 3.1/3.1 MB 200.0 MB/s eta 0:00:00
Collecting sphinx-rtd-theme<0.5
  Downloading sphinx_rtd_theme-0.4.3-py2.py3-none-any.whl (6.4 MB)
     ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 6.4/6.4 MB 201.0 MB/s eta 0:00:00
Collecting readthedocs-sphinx-ext<2.2
  Downloading readthedocs_sphinx_ext-2.1.9-py2.py3-none-any.whl (11 kB)
Collecting jinja2<3.1.0
  Downloading Jinja2-3.0.3-py3-none-any.whl (133 kB)
     ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 133.6/133.6 kB 214.8 MB/s eta 0:00:00
Collecting docutils>=0.11
  Downloading docutils-0.19-py3-none-any.whl (570 kB)
     ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 570.5/570.5 kB 250.1 MB/s eta 0:00:00
Collecting packaging
  Downloading packaging-21.3-py3-none-any.whl (40 kB)
     ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 40.8/40.8 kB 188.5 MB/s eta 0:00:00
Collecting Pygments>=2.0
  Downloading Pygments-2.13.0-py3-none-any.whl (1.1 MB)
     ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 1.1/1.1 MB 248.3 MB/s eta 0:00:00
Collecting babel!=2.0,>=1.3
  Downloading Babel-2.11.0-py3-none-any.whl (9.5 MB)
     ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 9.5/9.5 MB 200.8 MB/s eta 0:00:00
Requirement already satisfied: setuptools in /home/docs/checkouts/readthedocs.org/user_builds/nvidia-nemo/envs/main/lib/python3.7/site-packages (from sphinx<2) (58.2.0)
Collecting sphinxcontrib-websupport
  Downloading sphinxcontrib_websupport-1.2.4-py2.py3-none-any.whl (39 kB)
Collecting snowballstemmer>=1.1
  Downloading snowballstemmer-2.2.0-py2.py3-none-any.whl (93 kB)
     ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 93.0/93.0 kB 219.4 MB/s eta 0:00:00
Collecting six>=1.5
  Downloading six-1.16.0-py2.py3-none-any.whl (11 kB)
Collecting imagesize
  Downloading imagesize-1.4.1-py2.py3-none-any.whl (8.8 kB)
Collecting requests>=2.0.0
  Downloading requests-2.28.1-py3-none-any.whl (62 kB)
     ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 62.8/62.8 kB 197.1 MB/s eta 0:00:00
Collecting docutils>=0.11
  Downloading docutils-0.17.1-py2.py3-none-any.whl (575 kB)
     ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 575.5/575.5 kB 246.0 MB/s eta 0:00:00
Collecting MarkupSafe>=2.0
  Downloading MarkupSafe-2.1.1-cp37-cp37m-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (25 kB)
Collecting pytz>=2015.7
  Downloading pytz-2022.6-py2.py3-none-any.whl (498 kB)
     ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 498.1/498.1 kB 251.7 MB/s eta 0:00:00
Collecting idna<4,>=2.5
  Downloading idna-3.4-py3-none-any.whl (61 kB)
     ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 61.5/61.5 kB 191.1 MB/s eta 0:00:00
Collecting urllib3<1.27,>=1.21.1
  Downloading urllib3-1.26.12-py2.py3-none-any.whl (140 kB)
     ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 140.4/140.4 kB 227.7 MB/s eta 0:00:00
Collecting certifi>=2017.4.17
  Downloading certifi-2022.9.24-py3-none-any.whl (161 kB)
     ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 161.1/161.1 kB 231.7 MB/s eta 0:00:00
Collecting charset-normalizer<3,>=2
  Downloading charset_normalizer-2.1.1-py3-none-any.whl (39 kB)
Collecting pyparsing!=3.0.5,>=2.0.2
  Downloading pyparsing-3.0.9-py3-none-any.whl (98 kB)
     ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 98.3/98.3 kB 205.9 MB/s eta 0:00:00
Collecting sphinxcontrib-serializinghtml
  Downloading sphinxcontrib_serializinghtml-1.1.5-py2.py3-none-any.whl (94 kB)
     ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 94.0/94.0 kB 203.9 MB/s eta 0:00:00
Building wheels for collected packages: mock
  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=d52c34d198cdd0eb5803f5fa42aa6f834a70367cca1d91bb2951f44d43d695db
  Stored in directory: /tmp/pip-ephem-wheel-cache-afsrdd_k/wheels/d1/33/8e/f9d24f00cc130866aacfe7c3bc15571217e2b22cc4c4e1b443
Successfully built mock
Installing collected packages: snowballstemmer, pytz, mock, commonmark, alabaster, urllib3, sphinxcontrib-serializinghtml, six, pyparsing, Pygments, pillow, MarkupSafe, imagesize, idna, docutils, charset-normalizer, certifi, babel, sphinxcontrib-websupport, requests, packaging, jinja2, sphinx, readthedocs-sphinx-ext, sphinx-rtd-theme, recommonmark
Successfully installed MarkupSafe-2.1.1 Pygments-2.13.0 alabaster-0.7.12 babel-2.11.0 certifi-2022.9.24 charset-normalizer-2.1.1 commonmark-0.9.1 docutils-0.17.1 idna-3.4 imagesize-1.4.1 jinja2-3.0.3 mock-1.0.1 packaging-21.3 pillow-5.4.1 pyparsing-3.0.9 pytz-2022.6 readthedocs-sphinx-ext-2.1.9 recommonmark-0.5.0 requests-2.28.1 six-1.16.0 snowballstemmer-2.2.0 sphinx-1.8.6 sphinx-rtd-theme-0.4.3 sphinxcontrib-serializinghtml-1.1.5 sphinxcontrib-websupport-1.2.4 urllib3-1.26.12

[rtd-command-info] start-time: 2022-11-07T21:19:23.722364Z, end-time: 2022-11-07T21:19:30.267086Z, duration: 6, exit-code: 0
python -m pip install --exists-action=w --no-cache-dir -r requirements/requirements_docs.txt
Collecting latexcodec
  Downloading latexcodec-2.0.1-py2.py3-none-any.whl (18 kB)
Collecting numpy
  Downloading numpy-1.21.6-cp37-cp37m-manylinux_2_12_x86_64.manylinux2010_x86_64.whl (15.7 MB)
     ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 15.7/15.7 MB 186.3 MB/s eta 0:00:00
Collecting sphinx>=3.0
  Downloading sphinx-5.3.0-py3-none-any.whl (3.2 MB)
     ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 3.2/3.2 MB 211.9 MB/s eta 0:00:00
Collecting sphinx-book-theme
  Downloading sphinx_book_theme-0.3.3-py3-none-any.whl (345 kB)
     ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 345.7/345.7 kB 248.2 MB/s eta 0:00:00
Collecting sphinx-copybutton
  Downloading sphinx_copybutton-0.5.0-py3-none-any.whl (12 kB)
Collecting sphinxcontrib-bibtex
  Downloading sphinxcontrib_bibtex-2.5.0-py3-none-any.whl (39 kB)
Collecting wrapt
  Downloading wrapt-1.14.1-cp37-cp37m-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_17_x86_64.manylinux2014_x86_64.whl (75 kB)
     ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 75.2/75.2 kB 201.0 MB/s eta 0:00:00
Requirement already satisfied: six>=1.4.1 in /home/docs/checkouts/readthedocs.org/user_builds/nvidia-nemo/envs/main/lib/python3.7/site-packages (from latexcodec->-r requirements/requirements_docs.txt (line 1)) (1.16.0)
Requirement already satisfied: babel>=2.9 in /home/docs/checkouts/readthedocs.org/user_builds/nvidia-nemo/envs/main/lib/python3.7/site-packages (from sphinx>=3.0->-r requirements/requirements_docs.txt (line 3)) (2.11.0)
Requirement already satisfied: alabaster<0.8,>=0.7 in /home/docs/checkouts/readthedocs.org/user_builds/nvidia-nemo/envs/main/lib/python3.7/site-packages (from sphinx>=3.0->-r requirements/requirements_docs.txt (line 3)) (0.7.12)
Collecting sphinxcontrib-qthelp
  Downloading sphinxcontrib_qthelp-1.0.3-py2.py3-none-any.whl (90 kB)
     ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 90.6/90.6 kB 218.5 MB/s eta 0:00:00
Requirement already satisfied: packaging>=21.0 in /home/docs/checkouts/readthedocs.org/user_builds/nvidia-nemo/envs/main/lib/python3.7/site-packages (from sphinx>=3.0->-r requirements/requirements_docs.txt (line 3)) (21.3)
Requirement already satisfied: Jinja2>=3.0 in /home/docs/checkouts/readthedocs.org/user_builds/nvidia-nemo/envs/main/lib/python3.7/site-packages (from sphinx>=3.0->-r requirements/requirements_docs.txt (line 3)) (3.0.3)
Collecting importlib-metadata>=4.8
  Downloading importlib_metadata-5.0.0-py3-none-any.whl (21 kB)
Collecting sphinxcontrib-devhelp
  Downloading sphinxcontrib_devhelp-1.0.2-py2.py3-none-any.whl (84 kB)
     ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 84.7/84.7 kB 210.6 MB/s eta 0:00:00
Requirement already satisfied: docutils<0.20,>=0.14 in /home/docs/checkouts/readthedocs.org/user_builds/nvidia-nemo/envs/main/lib/python3.7/site-packages (from sphinx>=3.0->-r requirements/requirements_docs.txt (line 3)) (0.17.1)
Requirement already satisfied: imagesize>=1.3 in /home/docs/checkouts/readthedocs.org/user_builds/nvidia-nemo/envs/main/lib/python3.7/site-packages (from sphinx>=3.0->-r requirements/requirements_docs.txt (line 3)) (1.4.1)
Requirement already satisfied: snowballstemmer>=2.0 in /home/docs/checkouts/readthedocs.org/user_builds/nvidia-nemo/envs/main/lib/python3.7/site-packages (from sphinx>=3.0->-r requirements/requirements_docs.txt (line 3)) (2.2.0)
Requirement already satisfied: sphinxcontrib-serializinghtml>=1.1.5 in /home/docs/checkouts/readthedocs.org/user_builds/nvidia-nemo/envs/main/lib/python3.7/site-packages (from sphinx>=3.0->-r requirements/requirements_docs.txt (line 3)) (1.1.5)
Requirement already satisfied: requests>=2.5.0 in /home/docs/checkouts/readthedocs.org/user_builds/nvidia-nemo/envs/main/lib/python3.7/site-packages (from sphinx>=3.0->-r requirements/requirements_docs.txt (line 3)) (2.28.1)
Collecting sphinxcontrib-applehelp
  Downloading sphinxcontrib_applehelp-1.0.2-py2.py3-none-any.whl (121 kB)
     ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 121.2/121.2 kB 228.6 MB/s eta 0:00:00
Collecting sphinxcontrib-jsmath
  Downloading sphinxcontrib_jsmath-1.0.1-py2.py3-none-any.whl (5.1 kB)
Collecting sphinxcontrib-htmlhelp>=2.0.0
  Downloading sphinxcontrib_htmlhelp-2.0.0-py2.py3-none-any.whl (100 kB)
     ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 100.5/100.5 kB 225.4 MB/s eta 0:00:00
Requirement already satisfied: Pygments>=2.12 in /home/docs/checkouts/readthedocs.org/user_builds/nvidia-nemo/envs/main/lib/python3.7/site-packages (from sphinx>=3.0->-r requirements/requirements_docs.txt (line 3)) (2.13.0)
Collecting pyyaml
  Downloading PyYAML-6.0-cp37-cp37m-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_12_x86_64.manylinux2010_x86_64.whl (596 kB)
     ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 596.3/596.3 kB 243.6 MB/s eta 0:00:00
Collecting pydata-sphinx-theme~=0.8.0
  Downloading pydata_sphinx_theme-0.8.1-py3-none-any.whl (3.3 MB)
     ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 3.3/3.3 MB 218.6 MB/s eta 0:00:00
Collecting sphinx>=3.0
  Downloading Sphinx-4.5.0-py3-none-any.whl (3.1 MB)
     ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 3.1/3.1 MB 225.2 MB/s eta 0:00:00
Collecting pybtex>=0.24
  Downloading pybtex-0.24.0-py2.py3-none-any.whl (561 kB)
     ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 561.4/561.4 kB 247.3 MB/s eta 0:00:00
Collecting pybtex-docutils>=1.0.0
  Downloading pybtex_docutils-1.0.2-py3-none-any.whl (6.3 kB)
Requirement already satisfied: pytz>=2015.7 in /home/docs/checkouts/readthedocs.org/user_builds/nvidia-nemo/envs/main/lib/python3.7/site-packages (from babel>=2.9->sphinx>=3.0->-r requirements/requirements_docs.txt (line 3)) (2022.6)
Collecting typing-extensions>=3.6.4
  Downloading typing_extensions-4.4.0-py3-none-any.whl (26 kB)
Collecting zipp>=0.5
  Downloading zipp-3.10.0-py3-none-any.whl (6.2 kB)
Requirement already satisfied: MarkupSafe>=2.0 in /home/docs/checkouts/readthedocs.org/user_builds/nvidia-nemo/envs/main/lib/python3.7/site-packages (from Jinja2>=3.0->sphinx>=3.0->-r requirements/requirements_docs.txt (line 3)) (2.1.1)
Requirement already satisfied: pyparsing!=3.0.5,>=2.0.2 in /home/docs/checkouts/readthedocs.org/user_builds/nvidia-nemo/envs/main/lib/python3.7/site-packages (from packaging>=21.0->sphinx>=3.0->-r requirements/requirements_docs.txt (line 3)) (3.0.9)
Collecting beautifulsoup4
  Downloading beautifulsoup4-4.11.1-py3-none-any.whl (128 kB)
     ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 128.2/128.2 kB 228.8 MB/s eta 0:00:00
Requirement already satisfied: certifi>=2017.4.17 in /home/docs/checkouts/readthedocs.org/user_builds/nvidia-nemo/envs/main/lib/python3.7/site-packages (from requests>=2.5.0->sphinx>=3.0->-r requirements/requirements_docs.txt (line 3)) (2022.9.24)
Requirement already satisfied: urllib3<1.27,>=1.21.1 in /home/docs/checkouts/readthedocs.org/user_builds/nvidia-nemo/envs/main/lib/python3.7/site-packages (from requests>=2.5.0->sphinx>=3.0->-r requirements/requirements_docs.txt (line 3)) (1.26.12)
Requirement already satisfied: charset-normalizer<3,>=2 in /home/docs/checkouts/readthedocs.org/user_builds/nvidia-nemo/envs/main/lib/python3.7/site-packages (from requests>=2.5.0->sphinx>=3.0->-r requirements/requirements_docs.txt (line 3)) (2.1.1)
Requirement already satisfied: idna<4,>=2.5 in /home/docs/checkouts/readthedocs.org/user_builds/nvidia-nemo/envs/main/lib/python3.7/site-packages (from requests>=2.5.0->sphinx>=3.0->-r requirements/requirements_docs.txt (line 3)) (3.4)
Collecting soupsieve>1.2
  Downloading soupsieve-2.3.2.post1-py3-none-any.whl (37 kB)
Installing collected packages: zipp, wrapt, typing-extensions, sphinxcontrib-qthelp, sphinxcontrib-jsmath, sphinxcontrib-htmlhelp, sphinxcontrib-devhelp, sphinxcontrib-applehelp, soupsieve, pyyaml, numpy, latexcodec, pybtex, importlib-metadata, beautifulsoup4, sphinx, pybtex-docutils, sphinxcontrib-bibtex, sphinx-copybutton, pydata-sphinx-theme, sphinx-book-theme
  Attempting uninstall: sphinx
    Found existing installation: Sphinx 1.8.6
    Uninstalling Sphinx-1.8.6:
      Successfully uninstalled Sphinx-1.8.6
Successfully installed beautifulsoup4-4.11.1 importlib-metadata-5.0.0 latexcodec-2.0.1 numpy-1.21.6 pybtex-0.24.0 pybtex-docutils-1.0.2 pydata-sphinx-theme-0.8.1 pyyaml-6.0 soupsieve-2.3.2.post1 sphinx-4.5.0 sphinx-book-theme-0.3.3 sphinx-copybutton-0.5.0 sphinxcontrib-applehelp-1.0.2 sphinxcontrib-bibtex-2.5.0 sphinxcontrib-devhelp-1.0.2 sphinxcontrib-htmlhelp-2.0.0 sphinxcontrib-jsmath-1.0.1 sphinxcontrib-qthelp-1.0.3 typing-extensions-4.4.0 wrapt-1.14.1 zipp-3.10.0

[rtd-command-info] start-time: 2022-11-07T21:19:31.949702Z, end-time: 2022-11-07T21:19:32.029822Z, duration: 0, exit-code: 0
cat docs/source/conf.py
#!/usr/bin/env python3
# -*- coding: utf-8 -*-

# Copyright (c) 2020, NVIDIA CORPORATION.  All rights reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

import os
import re
import sys
import glob

import sphinx_book_theme

# 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.

sys.path.insert(0, os.path.abspath("../.."))
sys.path.insert(0, os.path.abspath("../../nemo"))
sys.path.insert(0, os.path.abspath("../../nemo_text_processing"))

from package_info import __version__

templates_path = ["_templates"]

autodoc_mock_imports = [
    'torch',
    'torch.nn',
    'torch.utils',
    'torch.optim',
    'torch.utils.data',
    'torch.utils.data.sampler',
    'torchtext',
    'ruamel.yaml',  # ruamel.yaml has ., which is troublesome for this regex
    'hydra',  # hydra-core in requirements, hydra during import
    'dateutil',  # part of core python
    'transformers.tokenization_bert',  # has ., troublesome for this regex
    'megatron',  # megatron-lm in requirements, megatron in import
    'sklearn',
    'nemo_text_processing.inverse_text_normalization',  # Not installed automatically
    'nemo_text_processing.text_normalization',  # Not installed automatically
    'attr',  # attrdict in requirements, attr in import
    'torchmetrics',  # inherited from PTL
    'apex',
    'joblib',
    'IPython',
    'ipadic',
    'psutil',
]

_skipped_autodoc_mock_imports = ['wrapt', 'numpy']

for req_path in sorted(list(glob.glob("../../requirements/*.txt"))):
    if "docs.txt" in req_path:
        continue

    req_file = os.path.abspath(os.path.expanduser(req_path))
    with open(req_file, 'r') as f:
        for line in f:
            line = line.replace("\n", "")
            req = re.search(r"([a-zA-Z0-9-_]*)", line)
            if req:
                req = req.group(1)
                req = req.replace("-", "_")

                if req not in autodoc_mock_imports:
                    if req in _skipped_autodoc_mock_imports:
                        print(f"Skipping req : `{req}` (lib {line})")
                        continue

                    autodoc_mock_imports.append(req)
                    print(f"Adding req : `{req}` to autodoc mock requirements (lib {line})")
                else:
                    print(f"`{req}` already added to autodoc mock requirements (lib {line})")

#
# -- 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.todo",
    "sphinx.ext.coverage",
    "sphinx.ext.mathjax",
    "sphinx.ext.ifconfig",
    "sphinx.ext.viewcode",
    "sphinx.ext.napoleon",
    "sphinx.ext.githubpages",
    "sphinxcontrib.bibtex",
    "sphinx.ext.inheritance_diagram",
    "sphinx.ext.intersphinx",
    "sphinx.ext.autosectionlabel",
    "sphinxcontrib.bibtex",
    "sphinx_copybutton",
    "IPython.sphinxext.ipython_console_highlighting",
    "IPython.sphinxext.ipython_directive",
]

bibtex_bibfiles = [
    'asr/asr_all.bib',
    'nlp/nlp_all.bib',
    'nlp/text_normalization/tn_itn_all.bib',
    'tools/tools_all.bib',
    'tts/tts_all.bib',
    'text_processing/text_processing_all.bib',
    'core/adapters/adapter_bib.bib',
]

intersphinx_mapping = {
    'pytorch': ('https://pytorch.org/docs/stable', None),
    'pytorch-lightning': ('https://pytorch-lightning.readthedocs.io/en/latest/', None),
}

# Set default flags for all classes.
autodoc_default_options = {'members': None, 'undoc-members': None, 'show-inheritance': True}

locale_dirs = ['locale/']  # path is example but recommended.
gettext_compact = False  # optional.

# 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"

# General information about the project.
project = "NVIDIA NeMo"
copyright = "© 2021-2022 NVIDIA Corporation & Affiliates. All rights reserved."
author = "NVIDIA CORPORATION"

# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
# built documents.


# The short X.Y version.
# version = "0.10.0"
version = __version__
# The full version, including alpha/beta/rc tags.
# release = "0.9.0"
release = __version__

# 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 patterns also effect to html_static_path and html_extra_path
exclude_patterns = []

# The name of the Pygments (syntax highlighting) style to use.
pygments_style = "default"

### Previous NeMo theme
# # NVIDIA theme settings.
# html_theme = 'nvidia_theme'

# html_theme_path = ["."]

# html_theme_options = {
#     'display_version': True,
#     'project_version': version,
#     'project_name': project,
#     'logo_path': None,
#     'logo_only': True,
# }
# html_title = 'Introduction'

# html_logo = html_theme_options["logo_path"]

# -- Options for HTMLHelp output ------------------------------------------

# Output file base name for HTML help builder.
htmlhelp_basename = "nemodoc"

### from TLT conf.py
# -- 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_path = [sphinx_rtd_theme.get_html_theme_path()]

html_theme = "sphinx_book_theme"
html_logo = os.path.join('nv_logo.png')
html_title = 'NVIDIA NeMo'

html_theme_options = {
    'logo_only': True,
    'display_version': True,
    # 'prev_next_buttons_location': 'bottom',
    # 'style_external_links': False,
    # 'style_nav_header_background': '#000000',
    # Toc options
    'collapse_navigation': False,
    # 'sticky_navigation': False,
    'navigation_depth': 10,
    # 'includehidden': False,
    # 'titles_only': False,
    # Sphinx Book theme,
    'repository_url': 'https://github.com/NVIDIA/NeMo',
    'use_repository_button': True,
    'show_navbar_depth': 1,
    'show_toc_level': 10,
}


# 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_favicon = 'favicon.ico'

html_static_path = ['_static']

html_last_updated_fmt = ''


def setup(app):
    app.add_css_file('css/custom.css')
    app.add_js_file('js/pk_scripts.js')


# html_css_files = [
#     './custom.css',
# ]

# html_js_files = [
#     './pk_scripts.js',
# ]




###########################################################################
#          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/main/readthedocs/doc_builder/templates/doc_builder/conf.py.tmpl
#
# Note: this file shouldn't rely on extra dependencies.

import importlib
import sys
import os.path

# Borrowed from six.
PY3 = sys.version_info[0] == 3
string_types = str if PY3 else basestring

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': "main",
    'version_slug': "main",
    'MEDIA_URL': "https://media.readthedocs.com/media/",
    'STATIC_URL': "https://assets.readthedocs.com/",
    'PRODUCTION_DOMAIN': "readthedocs.com",
    'proxied_static_path': "/deeplearning/nemo/user-guide/docs/_/static/",
    'versions': [
    ("stable", "/en/stable/"),
    ("v1.12.0", "/en/v1.12.0/"),
    ("v1.11.0", "/en/v1.11.0/"),
    ("v1.10.0", "/en/v1.10.0/"),
    ("v1.9.0", "/en/v1.9.0/"),
    ("v1.8.2", "/en/v1.8.2/"),
    ("v1.7.2", "/en/v1.7.2/"),
    ("v1.0.0", "/en/v1.0.0/"),
    ("main", "/en/main/"),
    ],
    'downloads': [ 
    ],
    'subprojects': [ 
    ],
    'slug': 'nvidia-nemo',
    'name': u'NeMo',
    'rtd_language': u'en',
    'programming_language': u'py',
    'canonical_url': 'https://nvidia-nemo.readthedocs-hosted.com/deeplearning/nemo/user-guide/docs/en/stable/',
    'analytics_code': 'None',
    'single_version': False,
    'conf_py_path': '/docs/source/',
    'api_host': 'https://readthedocs.com',
    'github_user': 'NVIDIA',
    'proxied_api_host': '/deeplearning/nemo/user-guide/docs/_',
    'github_repo': 'NeMo',
    'github_version': 'main',
    'display_github': True,
    'bitbucket_user': 'None',
    'bitbucket_repo': 'None',
    'bitbucket_version': 'main',
    'display_bitbucket': False,
    'gitlab_user': 'None',
    'gitlab_repo': 'None',
    'gitlab_version': 'main',
    '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': 'b8cc5030',
}

# For sphinx >=1.8 we can use html_baseurl to set the canonical URL.
# https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-html_baseurl
if version_info >= (1, 8):
    if not globals().get('html_baseurl'):
        html_baseurl = context['canonical_url']
    context['canonical_url'] = None





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")
    readthedocs_vcs_url = 'None'
    readthedocs_build_url = 'https://readthedocs.com/projects/nvidia-nemo/builds/1172032/'

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: 2022-11-07T21:19:32.260508Z, end-time: 2022-11-07T21:19:32.867957Z, duration: 0, exit-code: 2
python -m sphinx -T -E -b html -d _build/doctrees -D language=en . _build/html
Running Sphinx v4.5.0
Adding req : `huggingface_hub` to autodoc mock requirements (lib huggingface_hub)
Adding req : `numba` to autodoc mock requirements (lib numba)
Skipping req : `numpy` (lib numpy>=1.21)
Adding req : `onnx` to autodoc mock requirements (lib onnx>=1.7.0)
Adding req : `python_dateutil` to autodoc mock requirements (lib python-dateutil)
Adding req : `ruamel` to autodoc mock requirements (lib ruamel.yaml)
Adding req : `scikit_learn` to autodoc mock requirements (lib scikit-learn)
Adding req : `setuptools` to autodoc mock requirements (lib setuptools==59.5.0)
Adding req : `text_unidecode` to autodoc mock requirements (lib text-unidecode)
`torch` already added to autodoc mock requirements (lib torch)
Adding req : `tqdm` to autodoc mock requirements (lib tqdm>=4.41.0)
Adding req : `wget` to autodoc mock requirements (lib wget)
Skipping req : `wrapt` (lib wrapt)
Adding req : `braceexpand` to autodoc mock requirements (lib braceexpand)
Adding req : `editdistance` to autodoc mock requirements (lib editdistance)
Adding req : `g2p_en` to autodoc mock requirements (lib g2p_en)
Adding req : `inflect` to autodoc mock requirements (lib inflect)
Adding req : `ipywidgets` to autodoc mock requirements (lib ipywidgets)
Adding req : `kaldi_python_io` to autodoc mock requirements (lib kaldi-python-io)
Adding req : `kaldiio` to autodoc mock requirements (lib kaldiio)
Adding req : `librosa` to autodoc mock requirements (lib librosa>=0.9.0)
Adding req : `marshmallow` to autodoc mock requirements (lib marshmallow)
Adding req : `matplotlib` to autodoc mock requirements (lib matplotlib)
Adding req : `packaging` to autodoc mock requirements (lib packaging)
Adding req : `pyannote` to autodoc mock requirements (lib pyannote.core)
`pyannote` already added to autodoc mock requirements (lib pyannote.metrics)
Adding req : `pydub` to autodoc mock requirements (lib pydub)
`ruamel` already added to autodoc mock requirements (lib ruamel.yaml)
Adding req : `scipy` to autodoc mock requirements (lib scipy>=0.14)
Adding req : `soundfile` to autodoc mock requirements (lib soundfile)
Adding req : `sox` to autodoc mock requirements (lib sox)
Adding req : `texterrors` to autodoc mock requirements (lib texterrors)
Adding req : `pandas` to autodoc mock requirements (lib pandas)
Adding req : `sacremoses` to autodoc mock requirements (lib sacremoses>=0.0.43)
Adding req : `sentencepiece` to autodoc mock requirements (lib sentencepiece<1.0.0)
Adding req : `youtokentome` to autodoc mock requirements (lib youtokentome>=1.0.5)
Adding req : `hydra_core` to autodoc mock requirements (lib hydra-core>=1.2.0,<1.3)
Adding req : `omegaconf` to autodoc mock requirements (lib omegaconf>=2.2,<2.3)
Adding req : `pytorch_lightning` to autodoc mock requirements (lib pytorch-lightning>=1.7.0,<1.8)
Adding req : `pyyaml` to autodoc mock requirements (lib pyyaml<6  # Pinned until omegaconf works with pyyaml>=6)
`torchmetrics` already added to autodoc mock requirements (lib torchmetrics>=0.4.1rc0)
Adding req : `transformers` to autodoc mock requirements (lib transformers>=4.0.1,<=4.21.2)
Adding req : `wandb` to autodoc mock requirements (lib wandb)
Adding req : `webdataset` to autodoc mock requirements (lib webdataset>=0.1.48,<=0.1.62)
`inflect` already added to autodoc mock requirements (lib inflect)
Adding req : `regex` to autodoc mock requirements (lib regex)
Adding req : `boto3` to autodoc mock requirements (lib boto3)
Adding req : `einops` to autodoc mock requirements (lib einops)
Adding req : `faiss_cpu` to autodoc mock requirements (lib faiss-cpu)
Adding req : `fasttext` to autodoc mock requirements (lib fasttext)
Adding req : `flask_restful` to autodoc mock requirements (lib flask_restful)
Adding req : `ftfy` to autodoc mock requirements (lib ftfy)
Adding req : `gdown` to autodoc mock requirements (lib gdown)
Adding req : `h5py` to autodoc mock requirements (lib h5py)
Adding req : `ijson` to autodoc mock requirements (lib ijson)
`inflect` already added to autodoc mock requirements (lib inflect)
Adding req : `jieba` to autodoc mock requirements (lib jieba)
`matplotlib` already added to autodoc mock requirements (lib matplotlib>=3.3.2)
Adding req : `nltk` to autodoc mock requirements (lib nltk>=3.6.5)
Skipping req : `numpy` (lib numpy)
Adding req : `opencc` to autodoc mock requirements (lib opencc)
Adding req : `pangu` to autodoc mock requirements (lib pangu)
Adding req : `rapidfuzz` to autodoc mock requirements (lib rapidfuzz)
Adding req : `sacrebleu` to autodoc mock requirements (lib sacrebleu[ja])
Adding req : `sentence_transformers` to autodoc mock requirements (lib sentence_transformers)
Adding req : `jiwer` to autodoc mock requirements (lib jiwer>=2.0.0)
Adding req : `progress` to autodoc mock requirements (lib progress>=1.5)
Adding req : `tabulate` to autodoc mock requirements (lib tabulate>=0.8.7)
Adding req : `textdistance` to autodoc mock requirements (lib textdistance>=4.1.5)
`tqdm` already added to autodoc mock requirements (lib tqdm)
Adding req : `black` to autodoc mock requirements (lib black==19.10b0)
Adding req : `click` to autodoc mock requirements (lib click==8.0.2)
Adding req : `isort` to autodoc mock requirements (lib isort[requirements] < 5)
Adding req : `parameterized` to autodoc mock requirements (lib parameterized)
Adding req : `pytest` to autodoc mock requirements (lib pytest)
Adding req : `pytest_runner` to autodoc mock requirements (lib pytest-runner)
`ruamel` already added to autodoc mock requirements (lib ruamel.yaml)
Adding req : `sphinx` to autodoc mock requirements (lib sphinx)
Adding req : `sphinxcontrib_bibtex` to autodoc mock requirements (lib sphinxcontrib-bibtex)
`wandb` already added to autodoc mock requirements (lib wandb)
`wget` already added to autodoc mock requirements (lib wget)
Skipping req : `wrapt` (lib wrapt)
Adding req : `attrdict` to autodoc mock requirements (lib attrdict)
`einops` already added to autodoc mock requirements (lib einops)
`inflect` already added to autodoc mock requirements (lib inflect)
`librosa` already added to autodoc mock requirements (lib librosa)
`matplotlib` already added to autodoc mock requirements (lib matplotlib)
`nltk` already added to autodoc mock requirements (lib nltk)
`pandas` already added to autodoc mock requirements (lib pandas)
Adding req : `pesq` to autodoc mock requirements (lib pesq)
Adding req : `pypinyin` to autodoc mock requirements (lib pypinyin)
Adding req : `pystoi` to autodoc mock requirements (lib pystoi)
loading translations [en]... done

Traceback (most recent call last):
  File "/home/docs/checkouts/readthedocs.org/user_builds/nvidia-nemo/envs/main/lib/python3.7/site-packages/sphinx/registry.py", line 425, in load_extension
    mod = import_module(extname)
  File "/home/docs/checkouts/readthedocs.org/user_builds/nvidia-nemo/envs/main/lib/python3.7/importlib/__init__.py", line 127, in import_module
    return _bootstrap._gcd_import(name[level:], package, level)
  File "<frozen importlib._bootstrap>", line 1006, in _gcd_import
  File "<frozen importlib._bootstrap>", line 983, in _find_and_load
  File "<frozen importlib._bootstrap>", line 953, in _find_and_load_unlocked
  File "<frozen importlib._bootstrap>", line 219, in _call_with_frames_removed
  File "<frozen importlib._bootstrap>", line 1006, in _gcd_import
  File "<frozen importlib._bootstrap>", line 983, in _find_and_load
  File "<frozen importlib._bootstrap>", line 953, in _find_and_load_unlocked
  File "<frozen importlib._bootstrap>", line 219, in _call_with_frames_removed
  File "<frozen importlib._bootstrap>", line 1006, in _gcd_import
  File "<frozen importlib._bootstrap>", line 983, in _find_and_load
  File "<frozen importlib._bootstrap>", line 965, in _find_and_load_unlocked
ModuleNotFoundError: No module named 'IPython'

The above exception was the direct cause of the following exception:

Traceback (most recent call last):
  File "/home/docs/checkouts/readthedocs.org/user_builds/nvidia-nemo/envs/main/lib/python3.7/site-packages/sphinx/cmd/build.py", line 275, in build_main
    args.tags, args.verbosity, args.jobs, args.keep_going)
  File "/home/docs/checkouts/readthedocs.org/user_builds/nvidia-nemo/envs/main/lib/python3.7/site-packages/sphinx/application.py", line 223, in __init__
    self.setup_extension(extension)
  File "/home/docs/checkouts/readthedocs.org/user_builds/nvidia-nemo/envs/main/lib/python3.7/site-packages/sphinx/application.py", line 380, in setup_extension
    self.registry.load_extension(self, extname)
  File "/home/docs/checkouts/readthedocs.org/user_builds/nvidia-nemo/envs/main/lib/python3.7/site-packages/sphinx/registry.py", line 429, in load_extension
    err) from err
sphinx.errors.ExtensionError: Could not import extension IPython.sphinxext.ipython_console_highlighting (exception: No module named 'IPython')

Extension error:
Could not import extension IPython.sphinxext.ipython_console_highlighting (exception: No module named 'IPython')