The docs are not building due to griffe error

[frjo]

See https://github.com/HyphaApp/hypha/actions/runs/12706791687/job/35420413236#step:4:654 for error.

[frjo]

@theskumar Can you take a look at this when you have time?

Looks like griffe is complaining about this code:

hypha/hypha/apply/funds/workflows/registry.py

Lines 16 to 49 in c13130a

	from .definitions.double_stage import DoubleStageDefinition
	from .definitions.single_stage import SingleStageDefinition
	from .definitions.single_stage_community import SingleStageCommunityDefinition
	from .definitions.single_stage_external import SingleStageExternalDefinition
	from .definitions.single_stage_same import SingleStageSameDefinition
	from .models.phase import Phase
	from .models.workflow import Workflow
	def phase_data(phases):
	"""
	Transforms a workflow definition into a dictionary of Phase objects.
	Args:
	phases: A list of dictionaries defining the workflow phases and their configurations.
	Returns:
	dict: A dictionary where keys are phase names and values are Phase objects, each initialized
	with:
	- phase name
	- step number (order in workflow)
	- additional configuration data from the phase definition
	Example:
	Input phases = [
	{'draft': {'permissions': {...}}},
	{'review': {'permissions': {...}}}
	]
	Returns = {
	'draft': Phase('draft', step=0, permissions={...}),
	'review': Phase('review', step=1, permissions={...})
	}
	"""

Can we just stop griffe from scanning the code? We are not using it to build docs in any case.

[frjo]

Found that we do have code to document the API and that is removed now.

@theskumar Can you remove all the code around mkdocstrings, I assume we do not need any of it anymore?

[theskumar]

Can you remove all the code around mkdocstrings, I assume we do not need any of it anymore?

I believe wes added them to generate the reference docs.

https://docs.hypha.app/references/API/storage_backends/

[theskumar]

I could be missing __init__.py I'll take a stab at fixing the code.

[theskumar]

Found that we do have code to document the API and that is removed now.

@wes-otf would you like to keep the code docs generator.

[frjo]

I wrongly thought it was the literal /api/v1 docs but this is normal hypha code so it should stay in place.

[theskumar]

@frjo fixed the code that was causing this issue.

[wes-otf]

@theskumar what was the issue? missing typing?

[wes-otf]

definitely glad we kept the code docs though, but I agree the API label could be misleading

[theskumar]

@theskumar what was the issue? missing typing?
The issue was missing __init__.py.

If the __init__.py is not present the folders, they are not treated as module by griffee. I don't know the exact details but over time, python itself doesn't seem bother if __init__.py is missing, thats why rest of the code worked.