My sphinx doc builds have recently started failing after upgrading SQLAlchemy. It appears that this occurs b/c SQLA uses a Sphinx plugin for ":paramref:" directives. I'd rather not include this plugin. Is it normal for sphinx to fail b/c of documentation inside of a 3rd party import? Is there a way to prevent this?
veebers joined the channel
sdough
andornaut: Failing in what way?
andornaut
sdough: "ERROR: Unknown interpreted text role "paramref"."
It's complaining about myproject.case, where 'case' is actually imported from SQLA
It's used in SQLA, but not in my project. The OpenStack project worked around this issue by not importing the SQLA functions that use :paramref: directly, and instead using them as sqlalchemy...case
Hm. I'm not aware of such an option, but it does seem like one would be appropriate. Given that one can autodocument a module I'd expect the internals to be aware of module location.
sdough has quit
andornaut
I'll create a ticket. Though, I'll stick to describing the issue as I'm not sure how it'd be best resolved within Sphinx (i'd expect sphinx to simply not attempt to document 3rd party imports - and so not fail on unsupported directives)