Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Fix links in reference docs for py:class in the arguments of a method

See original GitHub issue

Example set_default_credentials has a Credentials class as part of its args. It’s being rendered in italics, but there’s no link to go to the Credentials class reference.

Args:

        credentials (:py:class:`Credentials <cartoframes.credentials.Credentials>`, optional):
          A :py:class:`Credentials <cartoframes.credentials.Credentials>`
          instance can be used in place of a `username | base_url`/`api_key` combination.

Screenshot 2019-11-18 at 15 32 24

Issue Analytics

State:
Created 4 years ago
Comments:5 (5 by maintainers)

Top GitHub Comments

1reaction

alrocarcommented, Nov 18, 2019

upss I checked the docs generated by sphinx and it’s not a link, so maybe it’s just a matter of the tag being used (maybe :obj: instead of :py:class:).

I assign this to me and I’m going to investigate.

Sorry for the noise 🙏

0reactions

josemazocommented, Jul 20, 2020

PR CARTOframes#1665

Top Results From Across the Web

Autodoc includes "self" as argument for class methods #6769

Describe the bug Autodoc includes "self" as argument for class methods. To Reproduce Have code with a class and class methods, run autodoc....

How to link to root page in intersphinx - Stack Overflow

I suspect that the answer will not really be tied to a library. If it matters any, the regular references to the pyserial...

Sphinx cheatsheet — AiiDA 1.2.0 documentation

Here is an external link to the Sphinx doc on this. ... In the docstring of a class, you can refer to a...

Python's property(): Add Managed Attributes to Your Classes

property(fget=None, fset=None, fdel=None, doc=None). The first two arguments take function objects that will play the role of getter ( fget ) and setter ......

How to use links in documentation - Contributor guide

Link text; Links from one article to another; Bookmark links; XRef (cross reference) links; Links from includes; Links in selectors ...