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

Fix docs build #3201

Merged
merged 4 commits into from
Aug 10, 2020
Merged

Fix docs build #3201

merged 4 commits into from
Aug 10, 2020

Conversation

balopat
Copy link
Contributor

@balopat balopat commented Aug 10, 2020

Fixes #3200.

As we will deprecate Sphinx soon anyway, and I wanted to have this situation resolved asap, I decided to pin to 3.1.* version of sphinx instead of fighting the new warnings from 3.2.0.

@googlebot googlebot added the cla: yes Makes googlebot stop complaining. label Aug 10, 2020
Copy link
Collaborator

@viathor viathor left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Does docs build only fail with Sphinx 3.2.0?

@balopat
Copy link
Contributor Author

balopat commented Aug 10, 2020

Does docs build only fail with Sphinx 3.2.0?

That's what it looks like from this PR. Locally on my Mac it threw 3 other warnings on 3.1.2 as well, that I find very confusing why that doesn't happen on the CI:

/Users/balintp/dev/proj/Cirq/cirq/google/__init__.py:docstring of cirq.google.NAMED_GATESETS:1: WARNING: Inline strong start-string without end-string.
/Users/balintp/dev/proj/Cirq/docs/api.rst.rst:41: WARNING: autosummary: stub file not found 'cirq.qft'. Check your autosummary_generate setting.
/Users/balintp/dev/proj/Cirq/docs/api.rst:541:<autosummary>:1: WARNING: Inline strong start-string without end-string.

@balopat
Copy link
Contributor Author

balopat commented Aug 10, 2020

Huh, but I think we should put some docs on NAMED_GATESET in the end - sphinx generates the docs of dict() for it 🤯
https://cirq.readthedocs.io/en/latest/api.html#google - which probably changed in one version of sphinx (on my Mac 3.1.2) which now includes **kwargs which then causes sphinx to think there is an unclosed ** (strong formatting).

@balopat balopat added the automerge Tells CirqBot to sync and merge this PR. (If it's running.) label Aug 10, 2020
@CirqBot CirqBot added the front_of_queue_automerge CirqBot uses this label to indicate (and remember) what's being merged next. label Aug 10, 2020
@CirqBot CirqBot merged commit 4e9681f into quantumlib:master Aug 10, 2020
@CirqBot CirqBot removed automerge Tells CirqBot to sync and merge this PR. (If it's running.) front_of_queue_automerge CirqBot uses this label to indicate (and remember) what's being merged next. labels Aug 10, 2020
@balopat
Copy link
Contributor Author

balopat commented Aug 10, 2020

Added #3202 to track the sphinx issues

tonybruguier pushed a commit to tonybruguier/Cirq that referenced this pull request Aug 23, 2020
Fixes quantumlib#3200.

As we will deprecate Sphinx soon anyway, and I wanted to have this situation resolved asap, I decided to pin to 3.1.* version of sphinx instead of fighting the new warnings from 3.2.0.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cla: yes Makes googlebot stop complaining.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Docs build is breaking PRs
4 participants