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

Treat docs warnings as errors #5825

merged 6 commits into from Jun 19, 2019


Copy link

@davidfischer davidfischer commented Jun 18, 2019

This PR builds on top of #5819. Start reviewing at commit 19ec28a.

  • Using the makefile in docs/ will treat warnings as errors during docs generation
  • The docs tests tox -e docs will treat warnings as errors during testing and CI
  • Fixes remaining docs warnings
- Move basic features that don't fit under guides/
- Remove the embed documentation which is broken
@davidfischer davidfischer requested a review from Jun 18, 2019
Copy link

@stsewd stsewd commented Jun 19, 2019

Copy link
Contributor Author

@davidfischer davidfischer commented Jun 19, 2019

Can you try removing these too?

I was able to remove (Duplicate implicit target name: ".*") and fix the lingering issues but (Hyperlink target ".*" is not referenced) is needed until myint/rstcheck#19 is fixed.

For example, here's one error it reports that looks erroneous:

./api/v2.rst:174: (INFO/1) Hyperlink target "api-version-detail" is not referenced.

Here's that line in the rst file but the hyperlink target is referenced just a few lines earlier.

Only a couple of the errors of this type are erroneous and I was able to fix the others.

stsewd approved these changes Jun 19, 2019
Copy link

@stsewd stsewd left a comment

Finally! really close to a full lint :)

@davidfischer davidfischer merged commit 082b454 into master Jun 19, 2019
2 checks passed
@davidfischer davidfischer deleted the davidfischer/docs-warnings-as-errors branch Jun 19, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
None yet
None yet
Linked issues

Successfully merging this pull request may close these issues.

None yet

2 participants