Skip to content

[docs] Update the sphinx-build options #36158

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

Closed

Conversation

benrimmington
Copy link
Contributor

The -W warnings as errors option can cause external builds to fail:

The -W option could either be removed, or replaced with:

(There's also a SPHINXOPTS environment variable.)

Note: The HTML documentation isn't built or tested by swift-ci.

@benrimmington
Copy link
Contributor Author

@swift-ci Please smoke test

@benrimmington
Copy link
Contributor Author

@swift-ci Please smoke test macOS platform

@Teemperor
Copy link
Contributor

Sorry, I don't think I'm the right person to review Swift patches.

@Teemperor Teemperor removed their request for review February 26, 2021 12:26
Copy link
Contributor

@eeckstein eeckstein left a comment

Choose a reason for hiding this comment

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

I think we should keep the doc build failing if there is a problem.
Instead we should add the doc build process to PR testing.
@shahmishal any chance we can do this?

@benrimmington benrimmington marked this pull request as draft March 2, 2021 18:36
@benrimmington benrimmington deleted the sphinx-build-options branch March 22, 2021 11:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants