💊 CI failures summary and remediations

As of commit c054df5 (more details on the Dr. CI page):

💚 💚 Looks good so far! There are no failures yet. 💚 💚

@mruberry
I don't know why trivial changes like this can cause docs build to fail, but the problem is:

The docs build on circle ci is failing with

/home/gaoxiang/.local/lib/python3.8/site-packages/torch/__init__.py:docstring of torch.bmm:: WARNING: more than one target found for cross-reference 'bool': torch.FloatStorage.bool, torch.Tensor.bool                                                                         
LaTeX-incompatible input and strict mode is set to 'warn': Unrecognized Unicode character "−" (8722) [unknownSymbol]                                                                                                                                                            
/home/gaoxiang/.local/lib/python3.8/site-packages/torch/__init__.py:docstring of torch.eye:: WARNING: more than one target found for cross-reference 'bool': torch.FloatStorage.bool, torch.Tensor.bool                                                                         
LaTeX-incompatible input and strict mode is set to 'warn': In LaTeX, \\ or \newline does nothing in display mode [newLineInDisplayMode]

which can be fixed by replacing the bool with

:class:`bool`

and generated docs are slightly different:

Current:

After change:

Both are correctly cross-referenced, the only difference is format.

Are you OK with this change? An alternative is to revert the change of docs of bmm and eye in this PR.

I agree with your assessment of the docs build. We recently enabled doc warnings causing the build to fail, and there are still some kinks to work out. Going with :class:bool sounds fine for now, although we should make a note to file an issue that this occurred so it can be solved in the future.

The failure on other builds, however, seems unrelated to those warnings. test_doc_template seems to be failing but I can't understand why, exactly. The formatting of torch.diag, which it says it's complaining about, appears correct to me. You may just want to revert the bmm, diag, and eye changes and then file two issues for these errors.

@mruberry merged this pull request in f63d06a.