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

Sphinx-build test should be nitpicky #219

Open
delgadom opened this issue Mar 13, 2017 · 0 comments
Open

Sphinx-build test should be nitpicky #219

delgadom opened this issue Mar 13, 2017 · 0 comments

Comments

@delgadom
Copy link
Member

Right now the sphinx-build is tested with the flag -W. This elevates warnings to errors.

I think eventually we should fix all of the reference errors in the docs and start testing the docs with -nW. The full test suite would then be:

$ sphinx-build -nW -b html -d docs/_build/doctrees docs/. docs/_build/html

We fail this test with small issues all over the place, and it's not worth throwing off our whole build process. But fixing these ref errors eventually is a good goal.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant