This is nice, I will merge it. However, it is not very discoverable right now. Is there some way we can give more information to users when they modify docs that their docs are viewable at some spot?

@kostmo maybe this is something Dr. CI could do?

it is not very discoverable right now. Is there some way we can give more information to users when they modify docs that their docs are viewable at some spot?

SciPy has a little GitHub app (https://github.com/apps/circleci-artifacts-redirector/) that adds a direct link as a separate CI result after the docs build job has completed:

It does require some permissions to install on this repo of course, not sure if that's desirable.

Otherwise it may be a matter of just teaching people. I'm personally not a fan of posting a comment after each CI run, that's way too noisy.

Unfortunately if this adds a link for every circleci artifact, we'll probably need to do some tweaking, as I think we do a lot of these right now

Unfortunately if this adds a link for every circleci artifact, we'll probably need to do some tweaking, as I think we do a lot of these right now

Ah yes, SciPy uses CircleCI only to build the docs. That app may need a tweak to work here, to take into account the job name. And since it's a Heroku app, it may need to be cloned and tweaked for PyTorch. Too much trouble at this point probably.

Permissions not too bad:

@ezyang merged this pull request in 66a20c2.

[...] Is there some way we can give more information to users when they modify docs that their docs are viewable at some spot?

@kostmo maybe this is something Dr. CI could do?

@ezyang , yes, sounds doable. The necessary ingredients would be associations of file glob patterns with jobs names, to determine which job artifacts link(s) we should surface through Dr. CI based on the files modified in the diff.

We could either store these associations as a text file in the pytorch repo or hard-code them in the Dr. CI app.

The necessary ingredients would be associations of file glob patterns with jobs names, to determine which job artifacts link(s)

• Job name: pytorch_python_doc_push
• Artifact link: https://xxxxxxx-xxxxxxxx-gh.circle-artifacts.com/0/docs/index.html

The necessary ingredients would be associations of file glob patterns with jobs names, to determine which job artifacts link(s)

• Job name: pytorch_python_doc_push
• Artifact link: https://xxxxxxx-xxxxxxxx-gh.circle-artifacts.com/0/docs/index.html

Is there a simple way to determine which files edited constitute changes to documentation? Is it as straightforward as any file that ends in the *.rst extension? Or perhaps any file underneath a certain directory in the repo?

Is there a simple way to determine which files edited constitute changes to documentation? Is it as straightforward as any file that ends in the *.rst extension? Or perhaps any file underneath a certain directory in the repo?

Like all the *.rst files under docs and all the *.py files under torch?

I don't think there's a good way to do that. Touching .py files may or may not result in changes to the docs (docstrings get extracted), and can result in changes in multiple places in the docs (e.g. in the autosummary table and in the page for the function(s) touched).

I'd just always link to the top-level index.html and let the reviewer figure it out. Saving an extra couple of clicks here isn't worth a complicated and possible incomplete link-generation exercise imho.

Yes, I agree. If it rolls into an existing comment the CI bot makes, it's NBD.