search

qoherent / ria

Radio Intelligence Apps' open-source core, by Qoherent 📡🚀
https://www.qoherent.ai/radiointelligenceapps-project/
GNU Affero General Public License v3.0
6 stars 0 forks source link

BUG: Fully qualified type hints in project documentation #21

Open mrl280 opened 3 months ago

mrl280 commented 3 months ago

Description: Type hints are fully qualified, despite specifying autodoc_typehints_format = "short" in docs/source/conf.py.

Screenshot 2024-03-14 152359

Project Area: Project documentation

Steps to Reproduce: Build shinx docs, using the procedure outlined in CODING.md.

Expected Behavior: Leading module names should be suppressed. E.g., expect Path, not pathlib.Path, and Dataset not utils.data.Dataset.

UmairK5669 commented 2 months ago

Took a stab at this but couldn't figure out how to entirely fix this. It seems some of the fixes that were mentioned have already been attempted when the docs were being initialized.

Here is an issue thread I came across. It seems helpful however, the main fix outlined here was to set python_use_unqualified_type_names = True, which seems to be already done for us and doesn't help.

I also came across the sphinx-autodoc-typehints project description on PyPi which can be found here. In it, it mentions the typehints_fully_qualified parameter, which we do not explicitly set in our conf.py however, the default is false so that shouln't be causing any issues. Still might be something to look into.