Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add sepes doc #97

Merged
merged 2 commits into from
Dec 19, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 31 additions & 0 deletions docs/API/core.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
🎯 Core API
=============================


.. currentmodule:: serket

.. autoclass:: TreeClass
:members:
at
.. autoclass:: Partial
.. autoclass:: partial
.. autoclass:: AtIndexer
:members:
get,
set,
apply,
scan,
reduce,
pluck,

.. autoclass:: at
.. autoclass:: BaseKey
:members:
__eq__
.. autofunction:: autoinit
.. autofunction:: leafwise
.. autofunction:: field
.. autofunction:: fields
.. autofunction:: bcmap
.. autofunction:: is_tree_equal
.. autofunction:: value_and_tree
11 changes: 11 additions & 0 deletions docs/API/masking.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
🥽 Masking API
----------------------------------------------

.. currentmodule:: serket

.. autofunction:: is_nondiff
.. autofunction:: freeze
.. autofunction:: unfreeze
.. autofunction:: is_frozen
.. autofunction:: tree_mask
.. autofunction:: tree_unmask
11 changes: 11 additions & 0 deletions docs/API/pretty_print.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
🎨 Pretty printing API
----------------------------------------------

.. currentmodule:: serket

.. autofunction:: tree_diagram
.. autofunction:: tree_graph
.. autofunction:: tree_mermaid
.. autofunction:: tree_repr
.. autofunction:: tree_str
.. autofunction:: tree_summary
10 changes: 9 additions & 1 deletion docs/API/sepes.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,12 @@

.. note::
`sepes <https://sepes.readthedocs.io/en/latest/?badge=latest>`_ API is fully re-exported under the ``serket`` namespace.
`Check the docs <https://sepes.readthedocs.io/en/latest/?badge=latest>`_ for full details.
`Check the docs <https://sepes.readthedocs.io/en/latest/?badge=latest>`_ for full details.

.. toctree::
:maxdepth: 2
:caption: API Documentation

core
masking
pretty_print
67 changes: 67 additions & 0 deletions docs/_static/tree_graph.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
67 changes: 67 additions & 0 deletions docs/_static/tree_graph_stylized.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_static/tree_mermaid copy.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion docs/notebooks/fields.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"This section introduces common recipes for fields. A `field` is a type hinted class variable that adds certain functionality to the class. For example, a `field` can be used to validate the input data, or to provide a default value. The notebook provides examples for common use cases."
"This section introduces common recipes for fields. A `field` is a type hinted class variable that adds certain functionality to the class. For example, a `field` can be used to validate the input data, or to provide a default value. The notebook provides examples for common use cases. `serket.field` is implemented as a [python descriptor](https://docs.python.org/3/howto/descriptor.html), which means that it can be used in any class not necessarily a `serket` class. Refer to the [python documentation](https://docs.python.org/3/howto/descriptor.html) for more information on descriptors and how they work."
]
},
{
Expand Down
Loading