Docs/structured api ref (#49)

Author: voorhs

Makefile

@@ -28,7 +28,6 @@ sync:
 
 .PHONY: docs
 docs:
-	$(poetry) sphinx-apidoc -e -E -f --remove-old -o docs/source/apiref autointent
 	$(poetry) python -m sphinx build -b html docs/source docs/build/html
 
 .PHONY: test-docs

autointent/__init__.py

@@ -1,3 +1,4 @@
+from ._embedder import Embedder
 from .context import Context
 
-__all__ = ["Context"]
+__all__ = ["Context", "Embedder"]

autointent/context/embedder.py autointent/_embedder.pyautointent/context/embedder.py renamed to autointent/_embedder.py

@@ -1,7 +1,7 @@
-from .inference_cli import InferenceConfig
-from .inference_pipeline import InferencePipelineConfig
-from .node import InferenceNodeConfig, NodeOptimizerConfig
-from .optimization_cli import (
+from ._inference_cli import InferenceConfig
+from ._inference_pipeline import InferencePipelineConfig
+from ._node import InferenceNodeConfig, NodeOptimizerConfig
+from ._optimization_cli import (
     AugmentationConfig,
     DataConfig,
     EmbedderConfig,
@@ -10,7 +10,7 @@
     TaskConfig,
     VectorIndexConfig,
 )
-from .pipeline_optimizer import PipelineOptimizerConfig
+from ._pipeline_optimizer import PipelineOptimizerConfig
 
 __all__ = [
     "AugmentationConfig",

autointent/utils.py autointent/_utils.pyautointent/utils.py renamed to autointent/_utils.py

@@ -4,7 +4,7 @@
 
 from omegaconf import MISSING
 
-from .node import InferenceNodeConfig
+from ._node import InferenceNodeConfig
 
 
 @dataclass

autointent/configs/__init__.py

@@ -7,7 +7,7 @@
 from hydra.core.config_store import ConfigStore
 from omegaconf import MISSING
 
-from .name import get_run_name
+from ._name import get_run_name
 
 
 @dataclass