Documentation for authentification objects is missing

[pmeier]

#205 moved the Authentication object from ragna.core to ragna.deploy. However, the latter is not part of our API documentation:

ragna/docs/references/python-api.md

Lines 1 to 7 in 38f75f6

	# Python API reference
	::: ragna.core
	::: ragna.source_storages
	::: ragna.assistants

In addition, ragna.deploy is also missing the block in the __init__.py file that hides our internal structure from the documentation. We can just copy the one from ragna.core

ragna/ragna/core/__init__.py

Lines 57 to 62 in 38f75f6

	# isort: split
	from ragna._utils import fix_module
	fix_module(globals())
	del fix_module

[kenudeh]

Hi. Was this authentication object documented while it was part of ragna.core? If it wasn't, then the need here is to document the content of the _authentication.py file? Is this correct?

[pmeier]

Was this authentication object documented while it was part of ragna.core?

Yes, it was. We are automatically creating the API documentation with mkdocstrings

ragna/mkdocs.yml

Lines 45 to 56 in 51fcda4

	- mkdocstrings:
	default_handler: python
	handlers:
	python:
	options:
	show_source: false
	show_root_heading: true
	show_bases: false
	unwrap_annotated: true
	import:
	- https://docs.python.org/3/objects.inv
	- https://fastapi.tiangolo.com/objects.inv

Meaning, if a class or function is included in the __all__ attribute of a module, e.g.

ragna/ragna/core/__init__.py

Lines 1 to 2 in 51fcda4

	__all__ = [
	"Assistant",

and given object has a docstring, e.g.

ragna/ragna/core/_components.py

Lines 210 to 211 in 51fcda4

	class Assistant(Component, abc.ABC):
	"""Abstract base class for assistants used in [ragna.core.Chat][]"""

This will automatically picked up when the documentation is built.

This was the case when the Authentication class was still part of ragna.core. But this missed when it was moved to ragna.deploy.