How to do intersphinx reference to confval in Sphinx docs?

[jdillard]

What is the recommended way to reference a confval in the Sphinx docs? It seems it would be:

:confval:`sphinx:extensions`

but that results in:

ERROR: Unknown interpreted text role "confval".

I can add the following to conf.py to fix:

def setup(app):
    app.add_object_type('confval', 'confval',
                        objname='Sphinx configuration value',
                        indextemplate='pair: %s; Sphinx configuration value')

but that seems overly complex.

Am I doing it wrong? Should the confval object type be nativity available for cross reference purposes?

[chrisjsewell]

oii @jdillard wait your turn, I was literally just typing about confval in #12152 😆

[jdillard]

haha what are the odds! I can close this and add it as part of the discussion there

[chrisjsewell]

I know right, yeh exactly was just finishing it up the final section and then definitely open to feedback 👌 (done)

[jdillard]

Discussion moved to https://github.com/orgs/sphinx-doc/discussions/12152