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

Start running our doc builds in nitpicky mode. #4166

Closed
wants to merge 1 commit into from

Conversation

ericholscher
Copy link
Member

This should catch any missing references and other issues.

It's expected to fail currently, and we should update this branch until
things pass properly.

@ericholscher ericholscher requested a review from stsewd May 30, 2018 18:56
@ericholscher ericholscher added the PR: work in progress Pull request is not ready for full review label May 30, 2018
@stsewd
Copy link
Member

stsewd commented May 31, 2018

There are a lot of errors due to duplicate implicit target name, two or more headers with the same name :/ it's quite impossible to rewrite that, sphinx-doc/sphinx#3388 looks like making more levels could work

This should catch any missing references and other issues.

It's expected to fail currently,
and we should update this branch until things pass properly.
@agjohnson agjohnson added this to the Documentation milestone Jun 8, 2018
@ericholscher ericholscher added the Status: blocked Issue is blocked on another issue label Jun 13, 2018
@ericholscher
Copy link
Member Author

You can test this locally by running make clean html SPHINXOPTS="-n"

@ericholscher
Copy link
Member Author

Closing this for now, since we aren't working on it.

@stsewd stsewd deleted the run-docs-tests-nitpicky branch October 31, 2018 14:47
@stsewd
Copy link
Member

stsewd commented Oct 31, 2018

We'll need to change the duplicated titles/subtitles to make this work, not sure if we can do that

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
PR: work in progress Pull request is not ready for full review Status: blocked Issue is blocked on another issue
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants