/dash-docset-torch

Dash/zeal docset for torch

Primary LanguageShell

dash-docset-torch

Some scripts to generate dash/zeal docset for torch, including nn, image, optim, paths package.

You can download the latest release here.

Steps to generate the docset

  • Install dashing, grip
  • cd THIS_REPO
  • ./mds/gen-html.sh
  • cd html && dashing build will give you a torch.docset folder.

For now it only roughly parses the markdown documentation in torch repo, naively by its header level. Functions might be missing. Please report if you find any issue.

screenshot

NOTE: sometimes grip could fail to render htmls due to github API limit. In this case you can pass your github username/password to the grip command in mds/gen-html.sh to avoid this. See grip issue.