[AstroPy] Fail to build documentation for astropy 1.3

Fri Jan 27 03:18:25 EST 2017

Hi Masato,

After installing sphinx-gallery, I now also get the same error.

It looks to me like a bug, and there was already a related Github issue, so I’ve summarised the information from this mailing list thread here:
https://github.com/astropy/astropy/issues/5019#issuecomment-275610995 <https://github.com/astropy/astropy/issues/5019#issuecomment-275610995>

Thanks for reporting this issue and posting the full build log!

Christoph

> On 27 Jan 2017, at 04:13, Masato Onodera <masato.onodera at gmail.com> wrote:
> 
> Hi, 
> 
> This is my full build log with a fresh astropy-1.3.tar.gz. 
> https://gist.github.com/monodera/4911502cfe70daaedd14c9c98d71a627 <https://gist.github.com/monodera/4911502cfe70daaedd14c9c98d71a627>
> 
> I found pyyaml and matplotlib is already installed (my python environment is basically astroconda).  I also installed sphinx-gallery, but the result is identical. 
> 
> As Brigitta pointed out, the latest documentation is not available through RtD, so I tried to do it by myself (actually the twitter post mentioned in the github issue is mine). 
> 
> Cheers,
> Masato
> 
> -- 
> Masato Onodera
> Sent with Airmail
> 
> On January 25, 2017 at 23:18:18, Simon Conseil (simon at sconseil.fr <mailto:simon at sconseil.fr>) wrote:
> 
>> Hi,
>> 
>> I can reproduce on a fresh environment, and I found that pyyaml and matplotlib are now hard requirements to build the docs: pyyaml for the astropy.io.misc.yaml module, and matplotlib for astropy.visualization.wcsaxes. Once you install both it should build !
>> You may also want to install sphinx-gallery <http://sphinx-gallery.readthedocs.io/> to build the examples, but this one is correctly mentioned in the install doc page.
>> 
>> Cheers,
>> Simon
>> 
>> 
>> Le 26/01/2017 à 08:42, Christoph Deil a écrit :
>>> 
>>>> On 26 Jan 2017, at 04:00, Masato Onodera <masato.onodera at gmail.com <mailto:masato.onodera at gmail.com>> wrote:
>>>> 
>>>> Hello, 
>>>> 
>>>> I'd like to build a documentation of astropy-1.3 to look at it when I'm not connected to the internet.  I followed the instruction (http://docs.astropy.org/en/stable/install.html#building-documentation <http://docs.astropy.org/en/stable/install.html#building-documentation>), but either ways do not work for me producing the following error message (this is for the case of "python setup.py build_docs").  I also tried both python 2.7 and 3.5 and got the same error.   Are there any ideas how to fix this?
>>>> 
>>>> Best regards,
>>>> Masato Onodera
>>>> 
>>>> 
>>>> Running Sphinx v1.5.1
>>>> loading pickled environment... not yet created
>>>> loading intersphinx inventory from http://docs.python.org/2/objects.inv <http://docs.python.org/2/objects.inv>...
>>>> intersphinx inventory has moved: http://docs.python.org/2/objects.inv <http://docs.python.org/2/objects.inv> -> https://docs.python.org/2/objects.inv <https://docs.python.org/2/objects.inv>
>>>> loading intersphinx inventory from http://matplotlib.org/objects.inv <http://matplotlib.org/objects.inv>...
>>>> loading intersphinx inventory from http://pandas.pydata.org/pandas-docs/stable/objects.inv <http://pandas.pydata.org/pandas-docs/stable/objects.inv>...
>>>> loading intersphinx inventory from http://ipython.readthedocs.io/en/stable/objects.inv <http://ipython.readthedocs.io/en/stable/objects.inv>...
>>>> loading intersphinx inventory from http://docs.scipy.org/doc/scipy/reference/objects.inv <http://docs.scipy.org/doc/scipy/reference/objects.inv>...
>>>> intersphinx inventory has moved: http://docs.scipy.org/doc/scipy/reference/objects.inv <http://docs.scipy.org/doc/scipy/reference/objects.inv> -> https://docs.scipy.org/doc/scipy/reference/objects.inv <https://docs.scipy.org/doc/scipy/reference/objects.inv>
>>>> loading intersphinx inventory from http://pytest.org/latest/objects.inv <http://pytest.org/latest/objects.inv>...
>>>> intersphinx inventory has moved: http://pytest.org/latest/objects.inv <http://pytest.org/latest/objects.inv> -> http://docs.pytest.org/en/latest/objects.inv <http://docs.pytest.org/en/latest/objects.inv>
>>>> loading intersphinx inventory from http://docs.h5py.org/en/latest/objects.inv <http://docs.h5py.org/en/latest/objects.inv>...
>>>> loading intersphinx inventory from http://docs.scipy.org/doc/numpy/objects.inv <http://docs.scipy.org/doc/numpy/objects.inv>...
>>>> intersphinx inventory has moved: http://docs.scipy.org/doc/numpy/objects.inv <http://docs.scipy.org/doc/numpy/objects.inv> -> https://docs.scipy.org/doc/numpy/objects.inv <https://docs.scipy.org/doc/numpy/objects.inv>
>>>> loading intersphinx inventory from /Users/monodera/packages/astropy-1.3/astropy_helpers/astropy_helpers/sphinx/local/python2_local_links.inv...
>>>> [autosummary] generating autosummary for: analytic_functions/index.rst, changelog.rst, config/config_0_4_transition.rst, config/index.rst, constants/index.rst, convolution/index.rst, convolution/kernels.rst, convolution/using.rst, coordinates/angles.rst, coordinates/definitions.rst, ..., wcs/relax.rst, whatsnew/0.1.rst, whatsnew/0.2.rst, whatsnew/0.3.rst, whatsnew/0.4.rst, whatsnew/1.0.rst, whatsnew/1.1.rst, whatsnew/1.2.rst, whatsnew/1.3.rst, whatsnew/index.rst
>>>> [automodsumm] vo/conesearch/index.rst: found 27 automodsumm entries to generate
>>>> [automodsumm] time/index.rst: found 30 automodsumm entries to generate
>>>> [automodsumm] io/ascii/index.rst: found 55 automodsumm entries to generate
>>>> [automodsumm] convolution/index.rst: found 22 automodsumm entries to generate
>>>> [automodsumm] stats/index.rst: found 34 automodsumm entries to generate
>>>> [automodsumm] vo/samp/index.rst: found 11 automodsumm entries to generate
>>>> [automodsumm] constants/index.rst: found 2 automodsumm entries to generate
>>>> [automodsumm] nddata/utils.rst: found 9 automodsumm entries to generate
>>>> [automodsumm] units/index.rst: found 86 automodsumm entries to generate
>>>> [automodsumm] logging.rst: found 3 automodsumm entries to generate
>>>> [automodsumm] cosmology/index.rst: found 11 automodsumm entries to generate
>>>> [automodsumm] visualization/wcsaxes/index.rst: found 10 automodsumm entries to generate
>>>> [automodsumm] io/votable/index.rst: found 33 automodsumm entries to generate
>>>> [automodsumm] config/index.rst: found 10 automodsumm entries to generate
>>>> [automodsumm] io/misc.rst: found 9 automodsumm entries to generate
>>>> [automodsumm] utils/index.rst: found 91 automodsumm entries to generate
>>>> [automodsumm] io/registry.rst: found 11 automodsumm entries to generate
>>>> [automodsumm] testhelpers.rst: found 13 automodsumm entries to generate
>>>> [automodsumm] wcs/index.rst: found 30 automodsumm entries to generate
>>>> [automodsumm] table/index.rst: found 22 automodsumm entries to generate
>>>> [automodsumm] visualization/index.rst: found 27 automodsumm entries to generate
>>>> [automodsumm] coordinates/index.rst: found 69 automodsumm entries to generate
>>>> [automodsumm] modeling/index.rst: found 189 automodsumm entries to generate
>>>> [automodsumm] nddata/index.rst: found 33 automodsumm entries to generate
>>>> [automodsumm] analytic_functions/index.rst: found 2 automodsumm entries to generate
>>>> ________________________________________________________________________________
>>>> Example directory ../examples does not have a README.txt file
>>>> Skipping this directory
>>>> ________________________________________________________________________________
>>>> Traceback (most recent call last):
>>>>   File "<stdin>", line 39, in <module>
>>>> NameError: name 'self' is not defined
>>>> Sphinx Documentation subprocess failed with return code 1
>>>> _______________________________________________
>>>> AstroPy mailing list
>>>> AstroPy at scipy.org <mailto:AstroPy at scipy.org>
>>>> https://mail.scipy.org/mailman/listinfo/astropy <https://mail.scipy.org/mailman/listinfo/astropy>
>>> 
>>> Hi Masato,
>>> 
>>> that’s a weird error message, with the traceback not mentioning a filename.
>>> 
>>> Could you please try again from a fresh Astropy 1.3 version to make sure you don’t have any accidental local file edits or something like that.
>>> 
>>> This should work:
>>> 
>>> Go to https://pypi.python.org/pypi/astropy/1.3 <https://pypi.python.org/pypi/astropy/1.3> and click on astropy-1.3.tar.gz
>>> tar zxf astropy-1.3.tar.gz
>>> cd astropy-1.3
>>> python setup.py build_docs
>>> # runs for ~ 10 minutes
>>> open docs/_build/html/index.html
>>> 
>>> It does work for me. Here’s my full build log:
>>> https://gist.github.com/cdeil/b0c0774b45966ecf05f04bde3d0a88a4 <https://gist.github.com/cdeil/b0c0774b45966ecf05f04bde3d0a88a4>
>>> 
>>> If it still doesn’t work for you, maybe you could post your full build log also.
>>> It might contain a clue like another warning or error about what’s wrong.
>>> 
>>> Good luck!
>>> Christoph
>>> 
>>> 
>>> _______________________________________________
>>> AstroPy mailing list
>>> AstroPy at scipy.org <mailto:AstroPy at scipy.org>
>>> https://mail.scipy.org/mailman/listinfo/astropy <https://mail.scipy.org/mailman/listinfo/astropy>
>> 
>> _______________________________________________ 
>> AstroPy mailing list 
>> AstroPy at scipy.org 
>> https://mail.scipy.org/mailman/listinfo/astropy 
> _______________________________________________
> AstroPy mailing list
> AstroPy at scipy.org <mailto:AstroPy at scipy.org>
> https://mail.scipy.org/mailman/listinfo/astropy <https://mail.scipy.org/mailman/listinfo/astropy>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://mail.python.org/pipermail/astropy/attachments/20170127/e7e258f4/attachment.html>