Skip to content
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.

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

Sphinx 3.1.0 breaks backward compatibility for autofunction #7809

Closed
leofang opened this issue Jun 9, 2020 · 3 comments
Closed

Sphinx 3.1.0 breaks backward compatibility for autofunction #7809

leofang opened this issue Jun 9, 2020 · 3 comments

Comments

@leofang
Copy link

leofang commented Jun 9, 2020

In cupy/cupy#3416 we had to temporarily regress to 3.0.4, because we encountered this error in the CI:

335 Warning, treated as error:
336 /home/travis/build/cupy/cupy/docs/source/reference/generated/cupy.fft.fft.rst:6:Error in "autofunction" directive:
337 1 argument(s) required, 0 supplied.
338 
339 .. autofunction::
340 Makefile:56: recipe for target 'html' failed
341 make: *** [html] Error 2
342 The command "SPHINXOPTS=-W make html" exited with 2.

See the full Travis log here: https://travis-ci.org/github/cupy/cupy/builds/696302151.

cc: @emcastillo

@tk0miya
Copy link
Member

tk0miya commented Jun 11, 2020

I think #7815 will also resolve this case. Could you try it please?

@tk0miya tk0miya added this to the 3.1.1 milestone Jun 11, 2020
@tk0miya
Copy link
Member

tk0miya commented Jun 14, 2020

I confirmed the HEAD of 3.1.x branch works fine for copy. So I'm closing this now. It will be released as 3.1.1 soon.

FROM python:3.8-slim

RUN apt update; apt install -y git make build-essential vim
RUN git clone https://github.com/cupy/cupy
WORKDIR /cupy
ENV CUPY_CI=travis
ENV READTHEDOCS=True
RUN pip install cython
RUN pip install -e .[travis]
WORKDIR /cupy/docs
RUN pip install -r requirements.txt
RUN pip install git+https://github.com/sphinx-doc/sphinx@3.1.x
RUN make html

@leofang
Copy link
Author

leofang commented Jun 14, 2020

Hi @tk0miya Thanks for quick action and test! I can confirm that when CuPy's Travis picks up 3.1.1 it does not complain: https://travis-ci.org/github/cupy/cupy/builds/698120966. Will report back if we encounter any issue in a full CI build.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Jul 23, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

No branches or pull requests

2 participants