Documentation API (e.g. for external documentation in IDEs such as Pycharm)

Hi there,
is there a proper API to access the documentation? I would like to make use of the external documentation functionality in Pycharm.
For example numpy’s documentation api is:
http://docs.scipy.org/doc/numpy/reference/{}generated/{module.name}.{element.name}.html

where available macros are
image

Cheers

Agree. That would be pretty helpful.
I am currently using https://pytorch.org/docs/master/torch.html#{element.qname}, but it may not work if the function is not under torch.html

I compiled the documentation for the master branch and put them on GitHub: https://github.com/ShawnZhong/PyTorchDoc.

You can use this link for PyTorch: https://shawnzhong.github.io/PyTorchDoc/index.html#{element.qname}

3 Likes

This settings works for me quite well:


troch.nn.functional -> https://pytorch.org/docs/stable/nn.functional.html#{element.qname}
torch -> https://pytorch.org/docs/stable/{module.basename}.html#{element.qname}

1 Like

This does not seem to work anymore. The new link to documentation should look like https://pytorch.org/docs/stable/generated/{module.basename}.html#{element.qname}, but it does not work for me in PyCharm either. Did something change since Sep’19?

Try this https://pytorch.org/docs/stable/generated/{element.qname.lower}.{class.name}.html#{element.qname.lower}.{class.name}

1 Like