Search code examples
python-3.xpython-sphinxrestructuredtext

Python constant values not detected


I'm trying to use sphinx cross-referencing and intersphinx to document my code. I can easily make hyperlinks to other docs, but Python should be included in core, and its constant values are not detected (True, False and None).

I imported interspinx and I have this in my mapping

intersphinx_mapping = {
    "python": ("https://docs.python.org/3.6", None),
    "discord": ("https://discordpy.readthedocs.io/en/rewrite/", None),
}

I can make a reference to discord by doing this

:class:`discord.Guild

I can also reference Python docs, like that

:py:class:`str`

However, if I try to reference True or False, it's not working. I'm doing this

:py:const:`True`

But the text is not a hyperlink...


Solution

  • Either of these will render the link.

    :py:obj:`True`
    
    :any:`True`