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

Make the CI fail when the docs syntax is invalid #287

Merged
merged 3 commits into from
Aug 25, 2021

Conversation

lbalmaceda
Copy link
Contributor

Changes

Adds a step to build the docs in the CI, failing if something if the syntax is wrong. This will help enforce good docs, now that we publish them to Readthedocs.

References

List of options: https://www.sphinx-doc.org/en/master/man/sphinx-build.html

  • -W converts warnings to errors
  • --keep-going will not stop in the first error, useful to get the complete list of errors.
  • -n will verify broken links and references
  • -a runs the docs generation task even when the source code hasn't changed

Testing

  • This change adds unit test coverage
  • This change adds integration test coverage
  • This change has been tested on the latest version of the platform/language or why not

Checklist

@lbalmaceda lbalmaceda added this to the v3-Next milestone Aug 25, 2021
@lbalmaceda lbalmaceda requested a review from a team as a code owner August 25, 2021 13:16
@lbalmaceda lbalmaceda merged commit a8e1c7e into master Aug 25, 2021
@lbalmaceda lbalmaceda deleted the ci-fail-with-docs branch August 25, 2021 13:36
@lbalmaceda lbalmaceda modified the milestones: v3-Next, 3.17.0 Aug 25, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants