Document how to generates the documentation

[nouiz]

Document how to generates the documentation.
This will help when we modify it, to be sure it is well generated.

[ptrendx]

The CI generates it using https://github.com/NVIDIA/TransformerEngine/blob/main/.github/workflows/docs.yml - if you submit the PR you can download the zipped version of the built documentation (as an example see https://github.com/NVIDIA/TransformerEngine/actions/runs/4805734879?pr=169)

[nouiz]

That should be added in the doc.
Any idea where it should be added in the doc?

Also, could we update the actions to add a comment in the PR with the link to the doc when it is generated? It would make it more accessible.

[ptrendx]

Do you mean a link to the website? The built documentation is not hosted anywhere unfortunately so the only link we could provide (potentially, I did not check the GitHub Actions docs yet on whether that's actually possible) is to the zip file.

[nouiz]

The zip file link is good.