DOC: fail to build if there are warnings #41335
Conversation
|
xref gh-32703: should this also close that issue? |
💊 CI failures summary and remediationsAs of commit 622feb6 (more details on the Dr. CI page): 💚 💚 Looks good so far! There are no failures yet. 💚 💚 This comment was automatically generated by Dr. CI (expand for details).Follow this link to opt-out of these comments for your Pull Requests.Please report bugs/suggestions on the GitHub issue tracker or post in the (internal) Dr. CI Users group. This comment has been revised 20 times. |
ailzhang
added
the
triaged
|
Prerequisites are merged, so let's see if this is still passing. |
|
@pytorchbot rebase this please |
|
Hmm the bot seems to be asleep. Also, the |
|
|
||
| # You can set these variables from the command line. | ||
| SPHINXOPTS ?= -j auto | ||
| SPHINXOPTS ?= -j auto -WT --keep-going |
There was a problem hiding this comment.
This is the actual one-liner meant to be in the PR
| wait | ||
| ScriptModule | ||
| ScriptFunction | ||
| freeze |
There was a problem hiding this comment.
freeze -> _freeze, it is now a private module
| def set_default_dtype(d): | ||
| r"""Sets the default floating point dtype to :attr:`d`. | ||
| This dtype is: | ||
| d (:class:`torch.dtype`): the floating point dtype to make the default | ||
| Example:: | ||
| Example: |
There was a problem hiding this comment.
not really an error, just a cleanup
| Example:: | ||
| Example: | ||
There was a problem hiding this comment.
blank line preferred
| tensor([[[-0.8079], | ||
| [ 0.7460]], | ||
| <BLANKLINE> |
There was a problem hiding this comment.
doctests need this to pass
There was a problem hiding this comment.
There are zero other instances of BLANKLINE, so I guess that makes this the only 3-D array in an example. Hence not worth cleaning this up with better doctest machinery I think.
A bit odd though that doctest failures don't turn into actual failures, that should be separate from -WT right?
| """Saves an object to a disk file. | ||
| See also: :ref:`recommend-saving-models` | ||
| See also: `saving-loading-tensors` |
There was a problem hiding this comment.
The file docs/source/notes/serialization.rst was refactored
mattip
left a comment
mattip
left a comment
There was a problem hiding this comment.
Fixed the docs build script too.
|
|
||
| # Install TensorBoard in python 3 so torch.utils.tensorboard classes render | ||
| pip install -q https://s3.amazonaws.com/ossci-linux/wheels/tensorboard-1.14.0a0-py3-none-any.whl | ||
|
|
There was a problem hiding this comment.
this is now handled via requirements.txt on line 62
facebook-github-bot
left a comment
facebook-github-bot
left a comment
There was a problem hiding this comment.
@mruberry has imported this pull request. If you are a Facebook employee, you can view this diff on Phabricator.
6 participants
Merge after gh-41334 and gh-41321 (EDIT: both are merged).
Closes gh-38011
This is the last in a series of PRs to build documentation without warnings. It adds
-WT --keepgoingto the shpinx build which will fail the build if there are warnings, print a trackeback on error and finish the build even when there are warnings.It should fail now, but pass once the PRs mentioned at the top are merged.