Skip to content

[docs] Update SIL.rst #36131

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

Merged
merged 1 commit into from
Feb 24, 2021
Merged

Conversation

benrimmington
Copy link
Contributor

@benrimmington benrimmington commented Feb 24, 2021

Follow-up to: #35993 (comment)

View file: docs/SIL.rst#is-unique

@benrimmington
Copy link
Contributor Author

@swift-ci Please test

@MaxDesiatov
Copy link
Contributor

MaxDesiatov commented Feb 24, 2021

Thanks for resolving this!

@Teemperor
Copy link
Contributor

Thanks

@swift-ci
Copy link
Contributor

Build failed
Swift Test Linux Platform
Git Sha - f21cd2d

@MaxDesiatov
Copy link
Contributor

@swift-ci please smoke test

@benrimmington
Copy link
Contributor Author

The swift-ci test (or smoke test) doesn't appear to build the HTML documentation.

CMake Warning at docs/CMakeLists.txt:24 (message):
  Unable to find sphinx-build program.  Not building docs

But I don't know if swift-ci toolchains or nightly snapshots will be broken?

Can the -W option be removed from docs/CMakeLists.txt, so that sphinx-build warnings don't break the entire build?

@MaxDesiatov
Copy link
Contributor

@swift-ci please smoke test Linux platform

@varungandhi-apple
Copy link
Contributor

Can the -W option be removed from docs/CMakeLists.txt, so that sphinx-build warnings don't break the entire build?

I think this should be okay. We don't have warnings as errors turned on for CI either. That said, I don't remember how long building the docs takes and whether it is happening serially or in parallel, so I'm not sure if we should be building the docs in CI by default... (is that what you're suggesting?)

@benrimmington
Copy link
Contributor Author

I'm not sure if we should be building the docs in CI by default... (is that what you're suggesting?)

No, I'm only suggesting that a broken link in documentation isn't serious enough to justify a complete build failure.

Since the docs_html phase isn't tested by swift-ci, we won't notice the failure until someone reports it.

@varungandhi-apple
Copy link
Contributor

Okay, yeah that sounds reasonable. FWIW, I'm okay with removing the -W.

@benrimmington benrimmington merged commit 8ae1b76 into swiftlang:main Feb 24, 2021
@benrimmington benrimmington deleted the docs-sil-rst branch February 24, 2021 20:40
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.

5 participants