Build docs using pixi, update docs.

.gitignore

@@ -137,3 +137,4 @@ venv.bak/
 
 
 src/dags/_version.py
+docs/source/_build/

.readthedocs.yaml

@@ -0,0 +1,16 @@
+---
+version: 2
+build:
+  os: ubuntu-lts-latest
+  tools:
+    python: '3.13'
+  jobs:
+    create_environment:
+      - asdf plugin add pixi
+      - asdf install pixi latest
+      - asdf global pixi latest
+    install:
+      - pixi install -e docs
+    build:
+      html:
+        - pixi run -e docs sphinx-build -T -b html docs/source $READTHEDOCS_OUTPUT/html

CHANGES.md

@@ -6,6 +6,9 @@ releases are available on [conda-forge](https://anaconda.org/conda-forge/dags).
 
 ## 0.5.0
 
+- :gh:`63` Build docs using pixi, update docs (:ghuser:`hmgaudecker`).
+- :gh:`64`  Loosen type annotation of `rename_arguments` decorator to prevent lots of
+  `# ty: ignore`s. (:ghuser:`hmgaudecker`).
 - :gh:`62` Drop Python 3.10 support, improve typing thanks to requiring current networkx
   (:ghuser:`hmgaudecker`).
 

docs/source/api.md

@@ -0,0 +1,135 @@
+# API Reference
+
+This page documents the public API of the dags library.
+
+## Core Functions
+
+The main functions for creating and executing DAGs.
+
+### concatenate_functions
+
+```{eval-rst}
+.. autofunction:: dags.concatenate_functions
+```
+
+### create_dag
+
+```{eval-rst}
+.. autofunction:: dags.create_dag
+```
+
+### get_ancestors
+
+```{eval-rst}
+.. autofunction:: dags.get_ancestors
+```
+
+## Annotation Functions
+
+Functions for working with type annotations and function signatures.
+
+### get_annotations
+
+```{eval-rst}
+.. autofunction:: dags.get_annotations
+```
+
+### get_free_arguments
+
+```{eval-rst}
+.. autofunction:: dags.get_free_arguments
+```
+
+### rename_arguments
+
+```{eval-rst}
+.. autofunction:: dags.rename_arguments
+```
+
+## Exceptions
+
+```{eval-rst}
+.. autoexception:: dags.DagsError
+   :show-inheritance:
+
+.. autoexception:: dags.AnnotationMismatchError
+   :show-inheritance:
+
+.. autoexception:: dags.CyclicDependencyError
+   :show-inheritance:
+
+.. autoexception:: dags.InvalidFunctionArgumentsError
+   :show-inheritance:
+
+.. autoexception:: dags.MissingFunctionsError
+   :show-inheritance:
+
+.. autoexception:: dags.ValidationError
+   :show-inheritance:
+```
+
+## dags.tree
+
+The tree module provides utilities for working with nested dictionaries and qualified names.
+
+### Tree Path Utilities
+
+```{eval-rst}
+.. autodata:: dags.tree.QNAME_DELIMITER
+
+.. autofunction:: dags.tree.qname_from_tree_path
+
+.. autofunction:: dags.tree.tree_path_from_qname
+
+.. autofunction:: dags.tree.qnames
+
+.. autofunction:: dags.tree.tree_paths
+```
+
+### Flatten/Unflatten Functions
+
+```{eval-rst}
+.. autofunction:: dags.tree.flatten_to_qnames
+
+.. autofunction:: dags.tree.unflatten_from_qnames
+
+.. autofunction:: dags.tree.flatten_to_tree_paths
+
+.. autofunction:: dags.tree.unflatten_from_tree_paths
+```
+
+### Tree DAG Functions
+
+```{eval-rst}
+.. autofunction:: dags.tree.create_dag_tree
+
+.. autofunction:: dags.tree.concatenate_functions_tree
+
+.. autofunction:: dags.tree.create_tree_with_input_types
+
+.. autofunction:: dags.tree.functions_without_tree_logic
+
+.. autofunction:: dags.tree.one_function_without_tree_logic
+```
+
+### Validation Functions
+
+```{eval-rst}
+.. autofunction:: dags.tree.fail_if_paths_are_invalid
+
+.. autofunction:: dags.tree.fail_if_path_elements_have_trailing_undersores
+
+.. autofunction:: dags.tree.fail_if_top_level_elements_repeated_in_paths
+
+.. autofunction:: dags.tree.fail_if_top_level_elements_repeated_in_single_path
+```
+
+### Tree Exceptions
+
+```{eval-rst}
+.. autoexception:: dags.tree.RepeatedTopLevelElementError
+   :show-inheritance:
+
+.. autoexception:: dags.tree.TrailingUnderscoreError
+   :show-inheritance:
+```