From 0d821a050516e596326e7f6a76c209b8281fd946 Mon Sep 17 00:00:00 2001 From: ASEM000 Date: Wed, 26 Jul 2023 06:33:53 +0900 Subject: [PATCH] docs --- docs/API/pytreeclass.rst | 12 +++++------- .../advanced_api.rst} | 4 ++-- .../core.rst} | 5 +++-- docs/API/pytreeclass/masking.rst | 11 +++++++++++ docs/API/pytreeclass/pretty_print.rst | 12 ++++++++++++ docs/API/pytreeclass_pretty_print.rst | 19 ------------------- 6 files changed, 33 insertions(+), 30 deletions(-) rename docs/API/{pytreeclass_advanced_api.rst => pytreeclass/advanced_api.rst} (88%) rename docs/API/{pytreeclass_core.rst => pytreeclass/core.rst} (82%) create mode 100644 docs/API/pytreeclass/masking.rst create mode 100644 docs/API/pytreeclass/pretty_print.rst delete mode 100644 docs/API/pytreeclass_pretty_print.rst diff --git a/docs/API/pytreeclass.rst b/docs/API/pytreeclass.rst index 2c79789..46820e9 100644 --- a/docs/API/pytreeclass.rst +++ b/docs/API/pytreeclass.rst @@ -1,13 +1,11 @@ -``PyTreeClass`` exported API +``PyTreeClass`` API ============================= -Serket relies on ``PyTreeClass`` :ref: for its module system (``TreeClass``). -The entire ``PyTreeClass`` is reexported for convinence and is defiend below. - .. toctree:: :maxdepth: 2 :caption: API Documentation - pytreeclass_core - pytreeclass_advanced_api - pytreeclass_pretty_print + pytreeclass/core + pytreeclass/masking + pytreeclass/advanced_api + pytreeclass/pretty_print diff --git a/docs/API/pytreeclass_advanced_api.rst b/docs/API/pytreeclass/advanced_api.rst similarity index 88% rename from docs/API/pytreeclass_advanced_api.rst rename to docs/API/pytreeclass/advanced_api.rst index 253f8cb..dee93ae 100644 --- a/docs/API/pytreeclass_advanced_api.rst +++ b/docs/API/pytreeclass/advanced_api.rst @@ -1,6 +1,6 @@ -Advanced API +➕ Advanced API --------------------------------------- -.. currentmodule:: serket +.. currentmodule:: pytreeclass .. autofunction:: bcmap .. autoclass:: Partial diff --git a/docs/API/pytreeclass_core.rst b/docs/API/pytreeclass/core.rst similarity index 82% rename from docs/API/pytreeclass_core.rst rename to docs/API/pytreeclass/core.rst index c97f569..7cd0932 100644 --- a/docs/API/pytreeclass_core.rst +++ b/docs/API/pytreeclass/core.rst @@ -1,7 +1,8 @@ -Core API +🎯 Core API ============================= -.. currentmodule:: serket + +.. currentmodule:: pytreeclass .. autoclass:: TreeClass .. autoclass:::members: at diff --git a/docs/API/pytreeclass/masking.rst b/docs/API/pytreeclass/masking.rst new file mode 100644 index 0000000..538cf5c --- /dev/null +++ b/docs/API/pytreeclass/masking.rst @@ -0,0 +1,11 @@ +💼 Masking API +---------------------------------------------- + +.. currentmodule:: pytreeclass + +.. autofunction:: is_nondiff +.. autofunction:: freeze +.. autofunction:: unfreeze +.. autofunction:: is_frozen +.. autofunction:: tree_mask +.. autofunction:: tree_unmask diff --git a/docs/API/pytreeclass/pretty_print.rst b/docs/API/pytreeclass/pretty_print.rst new file mode 100644 index 0000000..6d6c18b --- /dev/null +++ b/docs/API/pytreeclass/pretty_print.rst @@ -0,0 +1,12 @@ +🎨 Pretty printing API +---------------------------------------------- + +.. currentmodule:: pytreeclass + +.. autofunction:: tree_diagram +.. autofunction:: tree_graph +.. autofunction:: tree_mermaid +.. autofunction:: tree_repr +.. autofunction:: tree_str +.. autofunction:: tree_summary +.. autofunction:: tree_repr_with_trace \ No newline at end of file diff --git a/docs/API/pytreeclass_pretty_print.rst b/docs/API/pytreeclass_pretty_print.rst deleted file mode 100644 index ad19769..0000000 --- a/docs/API/pytreeclass_pretty_print.rst +++ /dev/null @@ -1,19 +0,0 @@ -Pretty printing API ----------------------------------------------- - -.. currentmodule:: serket - -.. autofunction:: tree_diagram -.. autofunction:: tree_graph -.. autofunction:: tree_mermaid -.. autofunction:: tree_repr -.. autofunction:: tree_str -.. autofunction:: tree_summary -.. autofunction:: tree_repr_with_trace -.. currentmodule:: serket -.. autofunction:: is_nondiff -.. autofunction:: freeze -.. autofunction:: unfreeze -.. autofunction:: is_frozen -.. autofunction:: tree_mask -.. autofunction:: tree_unmask