aaronmarkham opened a new pull request #13544: turn on Sphinx warnings as errors URL: https://github.com/apache/incubator-mxnet/pull/13544 ## Description ## This PR updates the makefile for docs to trigger sphinx-build with the `-W` switch. This turns on the "warnings as errors" feature in Sphinx. ## What This Means Once merged, anyone that submits a PR that breaks the docs - particularly the Python docs - **their PR will fail CI**. If you create a C operator that has docs strings that bubble up into the Python docs and break there, your PR will fail CI. ## Testing But let's not fail in CI all of the time. You can test it out first. 1. Turn off the doc sets you don't need to test in `docs/settings.ini`. Most of the time you just need to update the `[document_sets_default]` section. I tend to turn everything off for faster cycles on testing the build, then turn everything back on for a final test if my change messed with something that might trigger a Doxygen issue (C or C++ change) or Scala/Java docs issue (.scala or .java change). 2. Run `make html` from the docs folder. (or `make docs` from mxnet root) If it fails, read the error and fix it. Once you get a successful build, you're ready to submit your PR. For documentation help, check out the [documentation guide](https://cwiki.apache.org/confluence/display/MXNET/Documentation+Guide). For details on building the website, check out [how to build the website](https://cwiki.apache.org/confluence/display/MXNET/How+to+Build+the+Website) If you have questions, please ask!
---------------------------------------------------------------- This is an automated message from the Apache Git Service. To respond to the message, please log on GitHub and use the URL above to go to the specific comment. For queries about this service, please contact Infrastructure at: us...@infra.apache.org With regards, Apache Git Services
