Preview of built docs in the PR

[vfdev-5]

🚀 Feature

Idea is to be able to preview built docs on the CI to simplify PR review.
This issue may be a bit tricky to solve, here some guidelines:

• we build our docs with travis ci : https://github.com/pytorch/ignite/blob/master/.travis.yml#L62
• find out how we could keep built docs as artifacts and make them accessible after the build
• update .travis.yml for that
• update https://github.com/pytorch/ignite/blob/master/.github/PULL_REQUEST_TEMPLATE.md with some details on how to fetch the link of built docs.

For Hacktoberfest contributors, feel free to ask questions for details if any and say that you would like to tackle the issue.
Please, take a look at CONTRIBUTING guide.

[sroy8091]

@vfdev-5 currently are we using github pages for deploying docs?

[vfdev-5]

@sroy8091 yes, docs are built and deployed as a Travis CI job on master push: https://github.com/pytorch/ignite/blob/master/.travis.yml#L81

[sroy8091]

We can upload the artifact on build success to s3, including the build number as s3 bucket path. Next step would be to include that link in the pr.

[sroy8091]

Any better approach @vfdev-5 ?

[vfdev-5]

@sroy8091 I'm eager to do it with netlify like here : beeware/beeware.github.io#426
Let me check it first and conifgure it on netlify side. You can then provide additional info...

[vfdev-5]

Here is netlify configured:

• a test PR : DO NOT MERGE - Doc's preview #1348
  and docs preview for the PR : https://deploy-preview-1348--pytorch-ignite-preview.netlify.app/

Currently, it builds the docs as described in CONTRIBUTING and not as in travis (maybe OK).
What remains is to do:

• add condition to travis yaml to run Docs stage on master only
• update CONTRIBUTING guide saying that there "netlify/pytorch-ignite-preview/deploy-preview" check available to visualize the docs.

Nice to have:

• refactor travis yml such that:
  • before_install step runs .travis/install_deps.sh script with the content from travis
  • install step runs .travis/install_docs_deps.sh
  • script step runs .travis/build_docs.sh

These scripts can be reused with netlify to build the preview consistent with deployed docs.

[sroy8091]

awesome. will push the travis changes

[vfdev-5]

Close this as done