Skip to content

Document how to generates the documentation #177

Closed

Description

@nouiz

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

Activity

  1. ptrendx commented on Apr 26, 2023

    @ptrendx
    Member

    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)

  2. nouiz commented on Apr 27, 2023

    @nouiz
    CollaboratorAuthor

    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.

  3. ptrendx commented on Apr 27, 2023

    @ptrendx
    Member

    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.

  4. nouiz commented on Apr 27, 2023

    @nouiz
    CollaboratorAuthor

    The zip file link is good.

  5. self-assigned this
    on May 3, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

No labels
No labels

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions