Skip to content

Development documentation not up-to-date #311

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Closed
rossbar opened this issue Feb 20, 2021 · 5 comments
Closed

Development documentation not up-to-date #311

rossbar opened this issue Feb 20, 2021 · 5 comments

Comments

@rossbar
Copy link
Contributor

rossbar commented Feb 20, 2021

The documentation at https://numpydoc.readthedocs.io/en/latest/format.html appears to be development documentation as it refers to the 1.2dev0 tag, but doesn't contain documentation updates from recent PRs, e.g. the new docs on docstring validation from #302 .

Are the devdocs auto-deployed via CI or do they require a manual build+upload?
@larsoner
Copy link
Collaborator

Indeed, that PR was merged early Feb and the website says "Last updated on Jan 21, 2021".

I don't have numpydoc in https://readthedocs.org/dashboard/. @rgommers it looks like we hit this a year ago in #212 and you fixed it on RTD, any ideas?

@rgommers
Copy link
Member

I can add you @larsoner, what's your RTD username?

Nothing seems wrong at first sight, last build was 2 weeks ago and it's all green.

Here's the raw build log:

Read the Docs build information
Build id: 12965488
Project: numpydoc
Version: latest
Commit: ce6666ac82b6098b3d1b0909dc7a5eaef880b290
Date: 2021-02-08T13:26:32.702659Z
State: finished
Success: True


[rtd-command-info] start-time: 2021-02-08T13:26:35.494137Z, end-time: 2021-02-08T13:26:36.021329Z, duration: 0, exit-code: 0
git clone --no-single-branch --depth 50 https://github.com/numpy/numpydoc .
Cloning into '.'...

[rtd-command-info] start-time: 2021-02-08T13:26:36.240183Z, end-time: 2021-02-08T13:26:36.311508Z, duration: 0, exit-code: 0
git checkout --force origin/master
Note: checking out 'origin/master'.

You are in 'detached HEAD' state. You can look around, make experimental
changes and commit them, and you can discard any commits you make in this
state without impacting any branches by performing another checkout.

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

  git checkout -b <new-branch-name>

HEAD is now at ce6666a ENH: Enable validation during sphinx-build process (#302)

[rtd-command-info] start-time: 2021-02-08T13:26:36.593101Z, end-time: 2021-02-08T13:26:36.658422Z, duration: 0, exit-code: 0
git clean -d -f -f


[rtd-command-info] start-time: 2021-02-08T13:26:37.586575Z, end-time: 2021-02-08T13:26:37.676192Z, duration: 0, exit-code: 0
git submodule sync


[rtd-command-info] start-time: 2021-02-08T13:26:38.061908Z, end-time: 2021-02-08T13:26:38.565540Z, duration: 0, exit-code: 0
git submodule update --init --force --recursive doc/scipy-sphinx-theme
Submodule 'doc/scipy-sphinx-theme' (https://github.com/scipy/scipy-sphinx-theme) registered for path 'doc/scipy-sphinx-theme'
Cloning into '/home/docs/checkouts/readthedocs.org/user_builds/numpydoc/checkouts/latest/doc/scipy-sphinx-theme'...
Submodule path 'doc/scipy-sphinx-theme': checked out 'bc3b4b8383d4cd676fe75b7ca8c3e11d6afa8d97'

[rtd-command-info] start-time: 2021-02-08T13:26:40.483950Z, end-time: 2021-02-08T13:26:45.634687Z, duration: 5, exit-code: 0
python3.7 -mvirtualenv /home/docs/checkouts/readthedocs.org/user_builds/numpydoc/envs/latest
Using base prefix '/home/docs/.pyenv/versions/3.7.9'
New python executable in /home/docs/checkouts/readthedocs.org/user_builds/numpydoc/envs/latest/bin/python3.7
Also creating executable in /home/docs/checkouts/readthedocs.org/user_builds/numpydoc/envs/latest/bin/python
Installing setuptools, pip, wheel...
done.

[rtd-command-info] start-time: 2021-02-08T13:26:45.867630Z, end-time: 2021-02-08T13:26:46.876464Z, duration: 1, exit-code: 0
/home/docs/checkouts/readthedocs.org/user_builds/numpydoc/envs/latest/bin/python -m pip install --upgrade --no-cache-dir pip
Requirement already satisfied: pip in /home/docs/checkouts/readthedocs.org/user_builds/numpydoc/envs/latest/lib/python3.7/site-packages (21.0.1)

[rtd-command-info] start-time: 2021-02-08T13:26:47.056205Z, end-time: 2021-02-08T13:26:58.903505Z, duration: 11, exit-code: 0
/home/docs/checkouts/readthedocs.org/user_builds/numpydoc/envs/latest/bin/python -m pip install --upgrade --no-cache-dir setuptools==41.0.1  mock==1.0.1 pillow==5.4.1 alabaster>=0.7,<0.8,!=0.7.5 six commonmark==0.8.1 recommonmark==0.5.0 sphinx<2 sphinx-rtd-theme<0.5 readthedocs-sphinx-ext<2.2
Collecting setuptools==41.0.1
  Downloading setuptools-41.0.1-py2.py3-none-any.whl (575 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 six
  Downloading six-1.15.0-py2.py3-none-any.whl (10 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<2.2
  Downloading readthedocs_sphinx_ext-2.1.3-py2.py3-none-any.whl (11 kB)
Collecting future
  Downloading future-0.18.2.tar.gz (829 kB)
Collecting docutils>=0.11
  Downloading docutils-0.16-py2.py3-none-any.whl (548 kB)
Collecting Jinja2>=2.9
  Downloading Jinja2-2.11.3-py2.py3-none-any.whl (125 kB)
Collecting requests
  Downloading requests-2.25.1-py2.py3-none-any.whl (61 kB)
Collecting sphinxcontrib-websupport
  Downloading sphinxcontrib_websupport-1.2.4-py2.py3-none-any.whl (39 kB)
Collecting Pygments>=2.0
  Downloading Pygments-2.7.4-py3-none-any.whl (950 kB)
Collecting imagesize
  Downloading imagesize-1.2.0-py2.py3-none-any.whl (4.8 kB)
Collecting babel!=2.0,>=1.3
  Downloading Babel-2.9.0-py2.py3-none-any.whl (8.8 MB)
Collecting packaging
  Downloading packaging-20.9-py2.py3-none-any.whl (40 kB)
Collecting snowballstemmer>=1.1
  Downloading snowballstemmer-2.1.0-py2.py3-none-any.whl (93 kB)
Collecting pytz>=2015.7
  Downloading pytz-2021.1-py2.py3-none-any.whl (510 kB)
Collecting MarkupSafe>=0.23
  Downloading MarkupSafe-1.1.1-cp37-cp37m-manylinux2010_x86_64.whl (33 kB)
Collecting chardet<5,>=3.0.2
  Downloading chardet-4.0.0-py2.py3-none-any.whl (178 kB)
Collecting certifi>=2017.4.17
  Downloading certifi-2020.12.5-py2.py3-none-any.whl (147 kB)
Collecting urllib3<1.27,>=1.21.1
  Downloading urllib3-1.26.3-py2.py3-none-any.whl (137 kB)
Collecting idna<3,>=2.5
  Downloading idna-2.10-py2.py3-none-any.whl (58 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.4-py2.py3-none-any.whl (89 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=23755 sha256=e6d30841ee1897adabd9fc359c1ebc9905ac80e3a406eea844bbbf76a99c8c54
  Stored in directory: /tmp/pip-ephem-wheel-cache-w565drx0/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=491059 sha256=544377c9b3d39062a2b1694d10341348555ebc00f33b08b7c4adc864cb76f017
  Stored in directory: /tmp/pip-ephem-wheel-cache-w565drx0/wheels/56/b0/fe/4410d17b32f1f0c3cf54cdfb2bc04d7b4b8f4ae377e2229ba0
Successfully built mock future
Installing collected packages: urllib3, sphinxcontrib-serializinghtml, pytz, pyparsing, MarkupSafe, idna, chardet, certifi, sphinxcontrib-websupport, snowballstemmer, six, setuptools, requests, Pygments, packaging, Jinja2, imagesize, future, docutils, babel, alabaster, sphinx, commonmark, sphinx-rtd-theme, recommonmark, readthedocs-sphinx-ext, pillow, mock
  Attempting uninstall: setuptools
    Found existing installation: setuptools 53.0.0
    Uninstalling setuptools-53.0.0:
      Successfully uninstalled setuptools-53.0.0
Successfully installed Jinja2-2.11.3 MarkupSafe-1.1.1 Pygments-2.7.4 alabaster-0.7.12 babel-2.9.0 certifi-2020.12.5 chardet-4.0.0 commonmark-0.8.1 docutils-0.16 future-0.18.2 idna-2.10 imagesize-1.2.0 mock-1.0.1 packaging-20.9 pillow-5.4.1 pyparsing-2.4.7 pytz-2021.1 readthedocs-sphinx-ext-2.1.3 recommonmark-0.5.0 requests-2.25.1 setuptools-41.0.1 six-1.15.0 snowballstemmer-2.1.0 sphinx-1.8.5 sphinx-rtd-theme-0.4.3 sphinxcontrib-serializinghtml-1.1.4 sphinxcontrib-websupport-1.2.4 urllib3-1.26.3

[rtd-command-info] start-time: 2021-02-08T13:26:59.084418Z, end-time: 2021-02-08T13:27:06.521995Z, duration: 7, exit-code: 0
/home/docs/checkouts/readthedocs.org/user_builds/numpydoc/envs/latest/bin/python -m pip install --exists-action=w --no-cache-dir -r doc/requirements.txt
Collecting numpy
  Downloading numpy-1.20.1-cp37-cp37m-manylinux2010_x86_64.whl (15.3 MB)
Collecting matplotlib
  Downloading matplotlib-3.3.4-cp37-cp37m-manylinux1_x86_64.whl (11.5 MB)
Collecting cycler>=0.10
  Downloading cycler-0.10.0-py2.py3-none-any.whl (6.5 kB)
Collecting kiwisolver>=1.0.1
  Downloading kiwisolver-1.3.1-cp37-cp37m-manylinux1_x86_64.whl (1.1 MB)
Collecting pillow>=6.2.0
  Downloading Pillow-8.1.0-cp37-cp37m-manylinux1_x86_64.whl (2.2 MB)
Collecting python-dateutil>=2.1
  Downloading python_dateutil-2.8.1-py2.py3-none-any.whl (227 kB)
Requirement already satisfied: pyparsing!=2.0.4,!=2.1.2,!=2.1.6,>=2.0.3 in /home/docs/checkouts/readthedocs.org/user_builds/numpydoc/envs/latest/lib/python3.7/site-packages (from matplotlib->-r doc/requirements.txt (line 2)) (2.4.7)
Requirement already satisfied: six in /home/docs/checkouts/readthedocs.org/user_builds/numpydoc/envs/latest/lib/python3.7/site-packages (from cycler>=0.10->matplotlib->-r doc/requirements.txt (line 2)) (1.15.0)
Installing collected packages: python-dateutil, pillow, numpy, kiwisolver, cycler, matplotlib
  Attempting uninstall: pillow
    Found existing installation: Pillow 5.4.1
    Uninstalling Pillow-5.4.1:
      Successfully uninstalled Pillow-5.4.1
Successfully installed cycler-0.10.0 kiwisolver-1.3.1 matplotlib-3.3.4 numpy-1.20.1 pillow-8.1.0 python-dateutil-2.8.1

[rtd-command-info] start-time: 2021-02-08T13:27:06.711039Z, end-time: 2021-02-08T13:27:07.335593Z, duration: 0, exit-code: 0
/home/docs/checkouts/readthedocs.org/user_builds/numpydoc/envs/latest/bin/python /home/docs/checkouts/readthedocs.org/user_builds/numpydoc/checkouts/latest/setup.py install --force
running install
running bdist_egg
running egg_info
creating numpydoc.egg-info
writing numpydoc.egg-info/PKG-INFO
writing dependency_links to numpydoc.egg-info/dependency_links.txt
writing requirements to numpydoc.egg-info/requires.txt
writing top-level names to numpydoc.egg-info/top_level.txt
writing manifest file 'numpydoc.egg-info/SOURCES.txt'
reading manifest file 'numpydoc.egg-info/SOURCES.txt'
reading manifest template 'MANIFEST.in'
warning: no previously-included files found matching '.circleci/config.yml'
warning: no previously-included files found matching '.coveragerc'
warning: no previously-included files found matching 'codecov.yml'
warning: no previously-included files found matching '.gitmodules'
warning: no previously-included files matching '*.pyc' found anywhere in distribution
warning: no previously-included files matching '*~' found anywhere in distribution
warning: no previously-included files matching '*.bak' found anywhere in distribution
warning: no previously-included files matching '*.swp' found anywhere in distribution
warning: no previously-included files matching '*.pyo' found anywhere in distribution
writing manifest file 'numpydoc.egg-info/SOURCES.txt'
installing library code to build/bdist.linux-x86_64/egg
running install_lib
running build_py
creating build
creating build/lib
creating build/lib/numpydoc
copying numpydoc/docscrape_sphinx.py -> build/lib/numpydoc
copying numpydoc/xref.py -> build/lib/numpydoc
copying numpydoc/__init__.py -> build/lib/numpydoc
copying numpydoc/numpydoc.py -> build/lib/numpydoc
copying numpydoc/docscrape.py -> build/lib/numpydoc
copying numpydoc/validate.py -> build/lib/numpydoc
copying numpydoc/__main__.py -> build/lib/numpydoc
creating build/lib/numpydoc/tests
copying numpydoc/tests/test_validate.py -> build/lib/numpydoc/tests
copying numpydoc/tests/test_docscrape.py -> build/lib/numpydoc/tests
copying numpydoc/tests/test_numpydoc.py -> build/lib/numpydoc/tests
copying numpydoc/tests/test_main.py -> build/lib/numpydoc/tests
copying numpydoc/tests/test_full.py -> build/lib/numpydoc/tests
copying numpydoc/tests/test_xref.py -> build/lib/numpydoc/tests
creating build/lib/numpydoc/tests/tinybuild
copying numpydoc/tests/tinybuild/Makefile -> build/lib/numpydoc/tests/tinybuild
copying numpydoc/tests/tinybuild/index.rst -> build/lib/numpydoc/tests/tinybuild
copying numpydoc/tests/tinybuild/numpydoc_test_module.py -> build/lib/numpydoc/tests/tinybuild
copying numpydoc/tests/tinybuild/conf.py -> build/lib/numpydoc/tests/tinybuild
creating build/lib/numpydoc/templates
copying numpydoc/templates/numpydoc_docstring.rst -> build/lib/numpydoc/templates
creating build/bdist.linux-x86_64
creating build/bdist.linux-x86_64/egg
creating build/bdist.linux-x86_64/egg/numpydoc
copying build/lib/numpydoc/docscrape_sphinx.py -> build/bdist.linux-x86_64/egg/numpydoc
copying build/lib/numpydoc/xref.py -> build/bdist.linux-x86_64/egg/numpydoc
copying build/lib/numpydoc/__init__.py -> build/bdist.linux-x86_64/egg/numpydoc
creating build/bdist.linux-x86_64/egg/numpydoc/tests
copying build/lib/numpydoc/tests/test_validate.py -> build/bdist.linux-x86_64/egg/numpydoc/tests
copying build/lib/numpydoc/tests/test_docscrape.py -> build/bdist.linux-x86_64/egg/numpydoc/tests
creating build/bdist.linux-x86_64/egg/numpydoc/tests/tinybuild
copying build/lib/numpydoc/tests/tinybuild/numpydoc_test_module.py -> build/bdist.linux-x86_64/egg/numpydoc/tests/tinybuild
copying build/lib/numpydoc/tests/tinybuild/Makefile -> build/bdist.linux-x86_64/egg/numpydoc/tests/tinybuild
copying build/lib/numpydoc/tests/tinybuild/index.rst -> build/bdist.linux-x86_64/egg/numpydoc/tests/tinybuild
copying build/lib/numpydoc/tests/tinybuild/conf.py -> build/bdist.linux-x86_64/egg/numpydoc/tests/tinybuild
copying build/lib/numpydoc/tests/test_numpydoc.py -> build/bdist.linux-x86_64/egg/numpydoc/tests
copying build/lib/numpydoc/tests/test_main.py -> build/bdist.linux-x86_64/egg/numpydoc/tests
copying build/lib/numpydoc/tests/test_full.py -> build/bdist.linux-x86_64/egg/numpydoc/tests
copying build/lib/numpydoc/tests/test_xref.py -> build/bdist.linux-x86_64/egg/numpydoc/tests
copying build/lib/numpydoc/numpydoc.py -> build/bdist.linux-x86_64/egg/numpydoc
copying build/lib/numpydoc/docscrape.py -> build/bdist.linux-x86_64/egg/numpydoc
copying build/lib/numpydoc/validate.py -> build/bdist.linux-x86_64/egg/numpydoc
copying build/lib/numpydoc/__main__.py -> build/bdist.linux-x86_64/egg/numpydoc
creating build/bdist.linux-x86_64/egg/numpydoc/templates
copying build/lib/numpydoc/templates/numpydoc_docstring.rst -> build/bdist.linux-x86_64/egg/numpydoc/templates
byte-compiling build/bdist.linux-x86_64/egg/numpydoc/docscrape_sphinx.py to docscrape_sphinx.cpython-37.pyc
byte-compiling build/bdist.linux-x86_64/egg/numpydoc/xref.py to xref.cpython-37.pyc
byte-compiling build/bdist.linux-x86_64/egg/numpydoc/__init__.py to __init__.cpython-37.pyc
byte-compiling build/bdist.linux-x86_64/egg/numpydoc/tests/test_validate.py to test_validate.cpython-37.pyc
byte-compiling build/bdist.linux-x86_64/egg/numpydoc/tests/test_docscrape.py to test_docscrape.cpython-37.pyc
byte-compiling build/bdist.linux-x86_64/egg/numpydoc/tests/tinybuild/numpydoc_test_module.py to numpydoc_test_module.cpython-37.pyc
byte-compiling build/bdist.linux-x86_64/egg/numpydoc/tests/tinybuild/conf.py to conf.cpython-37.pyc
byte-compiling build/bdist.linux-x86_64/egg/numpydoc/tests/test_numpydoc.py to test_numpydoc.cpython-37.pyc
byte-compiling build/bdist.linux-x86_64/egg/numpydoc/tests/test_main.py to test_main.cpython-37.pyc
byte-compiling build/bdist.linux-x86_64/egg/numpydoc/tests/test_full.py to test_full.cpython-37.pyc
byte-compiling build/bdist.linux-x86_64/egg/numpydoc/tests/test_xref.py to test_xref.cpython-37.pyc
byte-compiling build/bdist.linux-x86_64/egg/numpydoc/numpydoc.py to numpydoc.cpython-37.pyc
byte-compiling build/bdist.linux-x86_64/egg/numpydoc/docscrape.py to docscrape.cpython-37.pyc
byte-compiling build/bdist.linux-x86_64/egg/numpydoc/validate.py to validate.cpython-37.pyc
byte-compiling build/bdist.linux-x86_64/egg/numpydoc/__main__.py to __main__.cpython-37.pyc
creating build/bdist.linux-x86_64/egg/EGG-INFO
copying numpydoc.egg-info/PKG-INFO -> build/bdist.linux-x86_64/egg/EGG-INFO
copying numpydoc.egg-info/SOURCES.txt -> build/bdist.linux-x86_64/egg/EGG-INFO
copying numpydoc.egg-info/dependency_links.txt -> build/bdist.linux-x86_64/egg/EGG-INFO
copying numpydoc.egg-info/requires.txt -> build/bdist.linux-x86_64/egg/EGG-INFO
copying numpydoc.egg-info/top_level.txt -> build/bdist.linux-x86_64/egg/EGG-INFO
zip_safe flag not set; analyzing archive contents...
numpydoc.__pycache__.docscrape.cpython-37: module MAY be using inspect.getsourcefile
numpydoc.__pycache__.docscrape_sphinx.cpython-37: module references __file__
numpydoc.__pycache__.validate.cpython-37: module MAY be using inspect.getsource
numpydoc.__pycache__.validate.cpython-37: module MAY be using inspect.getsourcefile
numpydoc.tests.__pycache__.test_full.cpython-37: module references __file__
numpydoc.tests.tinybuild.__pycache__.conf.cpython-37: module references __file__
creating dist
creating 'dist/numpydoc-1.2.dev0-py3.7.egg' and adding 'build/bdist.linux-x86_64/egg' to it
removing 'build/bdist.linux-x86_64/egg' (and everything under it)
Processing numpydoc-1.2.dev0-py3.7.egg
creating /home/docs/checkouts/readthedocs.org/user_builds/numpydoc/envs/latest/lib/python3.7/site-packages/numpydoc-1.2.dev0-py3.7.egg
Extracting numpydoc-1.2.dev0-py3.7.egg to /home/docs/checkouts/readthedocs.org/user_builds/numpydoc/envs/latest/lib/python3.7/site-packages
Adding numpydoc 1.2.dev0 to easy-install.pth file

Installed /home/docs/checkouts/readthedocs.org/user_builds/numpydoc/envs/latest/lib/python3.7/site-packages/numpydoc-1.2.dev0-py3.7.egg
Processing dependencies for numpydoc==1.2.dev0
Searching for Jinja2==2.11.3
Best match: Jinja2 2.11.3
Adding Jinja2 2.11.3 to easy-install.pth file

Using /home/docs/checkouts/readthedocs.org/user_builds/numpydoc/envs/latest/lib/python3.7/site-packages
Searching for Sphinx==1.8.5
Best match: Sphinx 1.8.5
Adding Sphinx 1.8.5 to easy-install.pth file
Installing sphinx-apidoc script to /home/docs/checkouts/readthedocs.org/user_builds/numpydoc/envs/latest/bin
Installing sphinx-autogen script to /home/docs/checkouts/readthedocs.org/user_builds/numpydoc/envs/latest/bin
Installing sphinx-build script to /home/docs/checkouts/readthedocs.org/user_builds/numpydoc/envs/latest/bin
Installing sphinx-quickstart script to /home/docs/checkouts/readthedocs.org/user_builds/numpydoc/envs/latest/bin

Using /home/docs/checkouts/readthedocs.org/user_builds/numpydoc/envs/latest/lib/python3.7/site-packages
Searching for MarkupSafe==1.1.1
Best match: MarkupSafe 1.1.1
Adding MarkupSafe 1.1.1 to easy-install.pth file

Using /home/docs/checkouts/readthedocs.org/user_builds/numpydoc/envs/latest/lib/python3.7/site-packages
Searching for imagesize==1.2.0
Best match: imagesize 1.2.0
Adding imagesize 1.2.0 to easy-install.pth file

Using /home/docs/checkouts/readthedocs.org/user_builds/numpydoc/envs/latest/lib/python3.7/site-packages
Searching for Pygments==2.7.4
Best match: Pygments 2.7.4
Adding Pygments 2.7.4 to easy-install.pth file
Installing pygmentize script to /home/docs/checkouts/readthedocs.org/user_builds/numpydoc/envs/latest/bin

Using /home/docs/checkouts/readthedocs.org/user_builds/numpydoc/envs/latest/lib/python3.7/site-packages
Searching for sphinxcontrib-websupport==1.2.4
Best match: sphinxcontrib-websupport 1.2.4
Adding sphinxcontrib-websupport 1.2.4 to easy-install.pth file

Using /home/docs/checkouts/readthedocs.org/user_builds/numpydoc/envs/latest/lib/python3.7/site-packages
Searching for requests==2.25.1
Best match: requests 2.25.1
Adding requests 2.25.1 to easy-install.pth file

Using /home/docs/checkouts/readthedocs.org/user_builds/numpydoc/envs/latest/lib/python3.7/site-packages
Searching for snowballstemmer==2.1.0
Best match: snowballstemmer 2.1.0
Adding snowballstemmer 2.1.0 to easy-install.pth file

Using /home/docs/checkouts/readthedocs.org/user_builds/numpydoc/envs/latest/lib/python3.7/site-packages
Searching for packaging==20.9
Best match: packaging 20.9
Adding packaging 20.9 to easy-install.pth file

Using /home/docs/checkouts/readthedocs.org/user_builds/numpydoc/envs/latest/lib/python3.7/site-packages
Searching for Babel==2.9.0
Best match: Babel 2.9.0
Adding Babel 2.9.0 to easy-install.pth file
Installing pybabel script to /home/docs/checkouts/readthedocs.org/user_builds/numpydoc/envs/latest/bin

Using /home/docs/checkouts/readthedocs.org/user_builds/numpydoc/envs/latest/lib/python3.7/site-packages
Searching for setuptools==41.0.1
Best match: setuptools 41.0.1
Adding setuptools 41.0.1 to easy-install.pth file
Installing easy_install script to /home/docs/checkouts/readthedocs.org/user_builds/numpydoc/envs/latest/bin
Installing easy_install-3.6 script to /home/docs/checkouts/readthedocs.org/user_builds/numpydoc/envs/latest/bin

Using /home/docs/checkouts/readthedocs.org/user_builds/numpydoc/envs/latest/lib/python3.7/site-packages
Searching for six==1.15.0
Best match: six 1.15.0
Adding six 1.15.0 to easy-install.pth file

Using /home/docs/checkouts/readthedocs.org/user_builds/numpydoc/envs/latest/lib/python3.7/site-packages
Searching for docutils==0.16
Best match: docutils 0.16
Adding docutils 0.16 to easy-install.pth file

Using /home/docs/checkouts/readthedocs.org/user_builds/numpydoc/envs/latest/lib/python3.7/site-packages
Searching for alabaster==0.7.12
Best match: alabaster 0.7.12
Adding alabaster 0.7.12 to easy-install.pth file

Using /home/docs/checkouts/readthedocs.org/user_builds/numpydoc/envs/latest/lib/python3.7/site-packages
Searching for sphinxcontrib-serializinghtml==1.1.4
Best match: sphinxcontrib-serializinghtml 1.1.4
Adding sphinxcontrib-serializinghtml 1.1.4 to easy-install.pth file

Using /home/docs/checkouts/readthedocs.org/user_builds/numpydoc/envs/latest/lib/python3.7/site-packages
Searching for certifi==2020.12.5
Best match: certifi 2020.12.5
Adding certifi 2020.12.5 to easy-install.pth file

Using /home/docs/checkouts/readthedocs.org/user_builds/numpydoc/envs/latest/lib/python3.7/site-packages
Searching for chardet==4.0.0
Best match: chardet 4.0.0
Adding chardet 4.0.0 to easy-install.pth file
Installing chardetect script to /home/docs/checkouts/readthedocs.org/user_builds/numpydoc/envs/latest/bin

Using /home/docs/checkouts/readthedocs.org/user_builds/numpydoc/envs/latest/lib/python3.7/site-packages
Searching for idna==2.10
Best match: idna 2.10
Adding idna 2.10 to easy-install.pth file

Using /home/docs/checkouts/readthedocs.org/user_builds/numpydoc/envs/latest/lib/python3.7/site-packages
Searching for urllib3==1.26.3
Best match: urllib3 1.26.3
Adding urllib3 1.26.3 to easy-install.pth file

Using /home/docs/checkouts/readthedocs.org/user_builds/numpydoc/envs/latest/lib/python3.7/site-packages
Searching for pyparsing==2.4.7
Best match: pyparsing 2.4.7
Adding pyparsing 2.4.7 to easy-install.pth file

Using /home/docs/checkouts/readthedocs.org/user_builds/numpydoc/envs/latest/lib/python3.7/site-packages
Searching for pytz==2021.1
Best match: pytz 2021.1
Adding pytz 2021.1 to easy-install.pth file

Using /home/docs/checkouts/readthedocs.org/user_builds/numpydoc/envs/latest/lib/python3.7/site-packages
Finished processing dependencies for numpydoc==1.2.dev0

[rtd-command-info] start-time: 2021-02-08T13:27:09.651402Z, end-time: 2021-02-08T13:27:09.721231Z, duration: 0, exit-code: 0
cat doc/conf.py
# -*- coding: utf-8 -*-
#
# project-template documentation build configuration file, created by
# sphinx-quickstart on Mon Jan 18 14:44:12 2016.
#
# This file is execfile()d with the current directory set to its
# containing dir.
#
# Note that not all possible configuration values are present in this
# autogenerated file.
#
# All configuration values have a default; values that are commented out
# serve to show the default.

import sys
import os
import re


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

# for example.py
sys.path.insert(0, os.path.abspath('.'))
# project root
sys.path.insert(0, os.path.abspath('..'))

os.environ['MPLBACKEND'] = 'Agg'  # avoid tkinter import errors on rtfd.io

# -- 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.autosummary',
    'sphinx.ext.doctest',
    'sphinx.ext.intersphinx',
    'sphinx.ext.todo',
    'numpydoc',
    'sphinx.ext.ifconfig',
    'sphinx.ext.viewcode',
]

try:
    import sphinx.ext.imgmath  # noqa
except ImportError:
    extensions.append('sphinx.ext.pngmath')
else:
    extensions.append('sphinx.ext.imgmath')

# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']

# The suffix of source filenames.
source_suffix = '.rst'

# The encoding of source files.
# source_encoding = 'utf-8-sig'

# The master toctree document.
master_doc = 'index'

# General information about the project.
project = u'numpydoc'
copyright = u'2019, numpydoc maintainers'

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

import numpydoc
# version = .__version__
# The full version, including alpha/beta/rc tags.
release = numpydoc.__version__
version = re.sub(r'(\d+\.\d+)\.\d+(.*)', r'\1\2', numpydoc.__version__)
version = re.sub(r'(\.dev\d+).*?$', r'\1', version)
numpydoc_xref_param_type = True
numpydoc_xref_ignore = {'optional', 'type_without_description', 'BadException'}
# Run docstring validation as part of build process
numpydoc_validation_checks = {"all", "GL01", "SA04", "RT03"}

# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
# language = None

# There are two options for replacing |today|: either, you set today to some
# non-false value, then it is used:
# today = ''
# Else, today_fmt is used as the format for a strftime call.
# today_fmt = '%B %d, %Y'

# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
exclude_patterns = ['_build', 'scipy-sphinx-theme']

# The reST default role (used for this markup: `text`) to use for all
# documents.
# default_role = None

# If true, '()' will be appended to :func: etc. cross-reference text.
# add_function_parentheses = True

# If true, the current module name will be prepended to all description
# unit titles (such as .. function::).
# add_module_names = True

# If true, sectionauthor and moduleauthor directives will be shown in the
# output. They are ignored by default.
# show_authors = False

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

# A list of ignored prefixes for module index sorting.
# modindex_common_prefix = []

# If true, keep warnings as "system message" paragraphs in the built documents.
# keep_warnings = False


# -- Options for HTML output ----------------------------------------------

# The theme to use for HTML and HTML Help pages.  See the documentation for
# a list of builtin themes.

themedir = os.path.join(os.path.dirname(__file__), 'scipy-sphinx-theme', '_theme')
if not os.path.isdir(themedir):
    raise RuntimeError("Get the scipy-sphinx-theme first, "
                       "via git submodule init && git submodule update")

html_theme = 'scipy'
html_theme_path = [themedir]

if 'scipyorg' in tags:  # noqa: F821
    # Build for the scipy.org website
    html_theme_options = {
        "edit_link": True,
        "sidebar": "right",
        "scipy_org_logo": True,
        "rootlinks": [("https://scipy.org/", "Scipy.org"),
                      ("https://docs.scipy.org/", "Docs")]
    }
else:
    # Default build
    html_theme_options = {
        "edit_link": False,
        "sidebar": "left",
        "scipy_org_logo": False,
        "rootlinks": []
    }
    html_sidebars = {}

html_title = "%s v%s Manual" % (project, version)
html_last_updated_fmt = '%b %d, %Y'

# 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']

# Add any extra paths that contain custom files (such as robots.txt or
# .htaccess) here, relative to this directory. These files are copied
# directly to the root of the documentation.
# html_extra_path = []

# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
# using the given strftime format.
# html_last_updated_fmt = '%b %d, %Y'

# If true, SmartyPants will be used to convert quotes and dashes to
# typographically correct entities.
# html_use_smartypants = True

# Custom sidebar templates, maps document names to template names.
# html_sidebars = {}

# Additional templates that should be rendered to pages, maps page names to
# template names.
# html_additional_pages = {}

# If false, no module index is generated.
# html_domain_indices = True

# If false, no index is generated.
# html_use_index = True

# If true, the index is split into individual pages for each letter.
# html_split_index = False

# If true, links to the reST sources are added to the pages.
# html_show_sourcelink = True

# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
# html_show_sphinx = True

# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
# html_show_copyright = True

# If true, an OpenSearch description file will be output, and all pages will
# contain a <link> tag referring to it.  The value of this option must be the
# base URL from which the finished HTML is served.
# html_use_opensearch = ''

# This is the file name suffix for HTML files (e.g. ".xhtml").
# html_file_suffix = None

# Output file base name for HTML help builder.
htmlhelp_basename = 'project-templatedoc'


# -- 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': '',
}

# 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 = [
    ('index', 'numpydoc.tex', u'numpydoc Documentation',
     u'Numpydoc maintainers', 'manual'),
]

# The name of an image file (relative to this directory) to place at the top of
# the title page.
# latex_logo = None

# For "manual" documents, if this is true, then toplevel headings are parts,
# not chapters.
# latex_use_parts = False

# If true, show page references after internal links.
# latex_show_pagerefs = False

# If true, show URL addresses after external links.
# latex_show_urls = False

# Documents to append as an appendix to all manuals.
# latex_appendices = []

# If false, no module index is generated.
# latex_domain_indices = True

# Documents to append as an appendix to all manuals.
# texinfo_appendices = []

# If false, no module index is generated.
# texinfo_domain_indices = True

# How to display URL addresses: 'footnote', 'no', or 'inline'.
# texinfo_show_urls = 'footnote'

# If true, do not generate a @detailmenu in the "Top" node's menu.
# texinfo_no_detailmenu = False


# Example configuration for intersphinx: refer to the Python standard library.
intersphinx_mapping = {
    'python': ('https://docs.python.org/3/', None),
    'numpy': ('https://numpy.org/devdocs/', None),
    'sklearn': ('https://scikit-learn.org/stable/', None),
}




###########################################################################
#          auto-created readthedocs.org specific configuration            #
###########################################################################


#
# The following code was added during an automated build on readthedocs.org
# It is auto created and injected for every build. The result is based on the
# conf.py.tmpl file found in the readthedocs.org codebase:
# https://github.com/rtfd/readthedocs.org/blob/master/readthedocs/doc_builder/templates/doc_builder/conf.py.tmpl
#


import importlib
import sys
import os.path
from six import string_types

from sphinx import version_info

# Get suffix for proper linking to GitHub
# This is deprecated in Sphinx 1.3+,
# as each page can have its own suffix
if globals().get('source_suffix', False):
    if isinstance(source_suffix, string_types):
        SUFFIX = source_suffix
    elif isinstance(source_suffix, (list, tuple)):
        # Sphinx >= 1.3 supports list/tuple to define multiple suffixes
        SUFFIX = source_suffix[0]
    elif isinstance(source_suffix, dict):
        # Sphinx >= 1.8 supports a mapping dictionary for multiple suffixes
        SUFFIX = list(source_suffix.keys())[0]  # make a ``list()`` for py2/py3 compatibility
    else:
        # default to .rst
        SUFFIX = '.rst'
else:
    SUFFIX = '.rst'

# Add RTD Static Path. Add to the end because it overwrites previous files.
if not 'html_static_path' in globals():
    html_static_path = []
if os.path.exists('_static'):
    html_static_path.append('_static')

# Add RTD Theme only if they aren't overriding it already
using_rtd_theme = (
    (
        'html_theme' in globals() and
        html_theme in ['default'] and
        # Allow people to bail with a hack of having an html_style
        'html_style' not in globals()
    ) or 'html_theme' not in globals()
)
if using_rtd_theme:
    theme = importlib.import_module('sphinx_rtd_theme')
    html_theme = 'sphinx_rtd_theme'
    html_style = None
    html_theme_options = {}
    if 'html_theme_path' in globals():
        html_theme_path.append(theme.get_html_theme_path())
    else:
        html_theme_path = [theme.get_html_theme_path()]

if globals().get('websupport2_base_url', False):
    websupport2_base_url = 'https://readthedocs.org/websupport'
    websupport2_static_url = 'https://assets.readthedocs.org/static/'


#Add project information to the template context.
context = {
    'using_theme': using_rtd_theme,
    'html_theme': html_theme,
    'current_version': "latest",
    'version_slug': "latest",
    'MEDIA_URL': "https://media.readthedocs.org/",
    'STATIC_URL': "https://assets.readthedocs.org/static/",
    'PRODUCTION_DOMAIN': "readthedocs.org",
    'versions': [
    ("latest", "/en/latest/"),
    ],
    'downloads': [ 
    ("html", "//numpydoc.readthedocs.io/_/downloads/en/latest/htmlzip/"),
    ],
    'subprojects': [ 
    ],
    'slug': 'numpydoc',
    'name': u'numpydoc',
    'rtd_language': u'en',
    'programming_language': u'py',
    'canonical_url': 'https://numpydoc.readthedocs.io/en/latest/',
    'analytics_code': '',
    'single_version': False,
    'conf_py_path': '/doc/',
    'api_host': 'https://readthedocs.org',
    'github_user': 'numpy',
    'proxied_api_host': '/_',
    'github_repo': 'numpydoc',
    'github_version': 'master',
    'display_github': True,
    'bitbucket_user': 'None',
    'bitbucket_repo': 'None',
    'bitbucket_version': 'master',
    'display_bitbucket': False,
    'gitlab_user': 'None',
    'gitlab_repo': 'None',
    'gitlab_version': 'master',
    'display_gitlab': False,
    'READTHEDOCS': True,
    'using_theme': (html_theme == "default"),
    'new_theme': (html_theme == "sphinx_rtd_theme"),
    'source_suffix': SUFFIX,
    'ad_free': False,
    'docsearch_disabled': False,
    'user_analytics_code': '',
    'global_analytics_code': 'UA-17997319-1',
    'commit': 'ce6666ac',
}

# 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.org/projects/numpydoc/builds/12965488/'

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-02-08T13:27:09.929872Z, end-time: 2021-02-08T13:27:18.516605Z, duration: 8, exit-code: 0
/home/docs/checkouts/readthedocs.org/user_builds/numpydoc/envs/latest/bin/python -m sphinx -T -E -b html -d _build/doctrees -D language=en . _build/html
Running Sphinx v1.8.5
loading translations [en]... done
making output directory...
loading intersphinx inventory from https://docs.python.org/3/objects.inv...
loading intersphinx inventory from https://numpy.org/devdocs/objects.inv...
loading intersphinx inventory from https://scikit-learn.org/stable/objects.inv...
building [mo]: targets for 0 po files that are out of date
building [html]: targets for 6 source files that are out of date
updating environment: 6 added, 0 changed, 0 removed
reading sources... [ 16%] example
Matplotlib is building the font cache; this may take a moment.
reading sources... [ 33%] format
reading sources... [ 50%] index
reading sources... [ 66%] install
reading sources... [ 83%] release_notes
reading sources... [100%] validation

looking for now-outdated files... none found
pickling environment... done
checking consistency... done
preparing documents... done
writing output... [ 16%] example
writing output... [ 33%] format
writing output... [ 50%] index
writing output... [ 66%] install
writing output... [ 83%] release_notes
writing output... [100%] validation

generating indices... genindex py-modindex
highlighting module code... [100%] example

writing additional pages... search
copying static files... done
copying extra files... done
dumping search index in English (code: en) ... done
dumping object inventory... done
build succeeded.

The HTML pages are in _build/html.
Updating searchtools for Read the Docs search... /home/docs/checkouts/readthedocs.org/user_builds/numpydoc/envs/latest/lib/python3.7/site-packages/sphinx/util/nodes.py:94: FutureWarning: 
   The iterable returned by Node.traverse()
   will become an iterator instead of a list in Docutils > 0.16.
  for classifier in reversed(node.parent.traverse(nodes.classifier)):

[rtd-command-info] start-time: 2021-02-08T13:27:18.795318Z, end-time: 2021-02-08T13:27:20.266224Z, duration: 1, exit-code: 0
/home/docs/checkouts/readthedocs.org/user_builds/numpydoc/envs/latest/bin/python -m sphinx -T -b readthedocssinglehtmllocalmedia -d _build/doctrees -D language=en . _build/localmedia
Running Sphinx v1.8.5
loading translations [en]... done
making output directory...
loading pickled environment... done
building [mo]: targets for 0 po files that are out of date
building [readthedocssinglehtmllocalmedia]: all documents
updating environment: 0 added, 0 changed, 0 removed
looking for now-outdated files... none found
preparing documents... done
assembling single document... install release_notes format example validation 
writing... done
writing additional files...
copying static files... done
copying extra files... done
dumping object inventory... done
build succeeded.

The HTML page is in _build/localmedia.
Updating searchtools for Read the Docs search...

@larsoner
Copy link
Collaborator

Something is weird because the install page and index.html both say they were last updated Jan 21, 2021, but the format page says it was last updated Feb 8th 2021. Not sure how we got in a state with some pages having different dates from others like this.

My RTD username is larsoner

@rgommers
Copy link
Member

My RTD username is larsoner

you have access now

@larsoner
Copy link
Collaborator

No idea why it didn't work before, but I just triggered a new build manually and it looks correct now: https://numpydoc.readthedocs.io/en/latest/install.html#sphinx-config-options

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@rgommers @rossbar @larsoner