Update Sphinx documentation, commit 7511ffb [skip ci].

bluescarni · Jan 21, 2024 · 78ae3ab · 78ae3ab
1 parent 96269ac
commit 78ae3ab
Show file tree

Hide file tree

Showing 119 changed files with 4,017 additions and 1,822 deletions.
diff --git a/_images/0d4246d6f083c569fc40dd0da531c629345f4a975de5a1756efb436afbe18c9c.png b/_images/0d4246d6f083c569fc40dd0da531c629345f4a975de5a1756efb436afbe18c9c.png
diff --git a/_images/0e15aa108154700837547287e70b2e0fc21ccef0541c6cbbd7889bccb8f6a2c5.png b/_images/0e15aa108154700837547287e70b2e0fc21ccef0541c6cbbd7889bccb8f6a2c5.png
diff --git a/_images/15b44644ee13c3e927159689f870ffca62b3488f9936c21f3b4f69a278322605.png b/_images/15b44644ee13c3e927159689f870ffca62b3488f9936c21f3b4f69a278322605.png
diff --git a/_images/27d76ff03dc2f950cd181a0ab708eb3fecdcafd6ec646f834c82bddd89391005.png b/_images/27d76ff03dc2f950cd181a0ab708eb3fecdcafd6ec646f834c82bddd89391005.png
diff --git a/_images/3bd20e7450df0e0aec1adbbb611b183d5bbdd78a5621a14cc461ffe60de5b5e4.png b/_images/3bd20e7450df0e0aec1adbbb611b183d5bbdd78a5621a14cc461ffe60de5b5e4.png
diff --git a/_images/4a91d7bb4229da4d1d0ce30e1a92e20a778cf8ec4e73a6086d14dd9105f190db.png b/_images/4a91d7bb4229da4d1d0ce30e1a92e20a778cf8ec4e73a6086d14dd9105f190db.png
diff --git a/_images/4ddad5bd60a6a0018958a4ad5a7c9a576e4d4bd02f57cc68602d224665ae0790.png b/_images/4ddad5bd60a6a0018958a4ad5a7c9a576e4d4bd02f57cc68602d224665ae0790.png
diff --git a/_images/6fc01fcd9e3b8af1ad6ff8a476755f55d949fd09c5994d93f6566167e6e2c855.png b/_images/6fc01fcd9e3b8af1ad6ff8a476755f55d949fd09c5994d93f6566167e6e2c855.png
diff --git a/_images/7f01c310262bcdd9edea43a973573e46063d9d37bb85a2849c08830ce8a558ba.png b/_images/7f01c310262bcdd9edea43a973573e46063d9d37bb85a2849c08830ce8a558ba.png
diff --git a/_images/8299fbb1369ab8adbd2606465eaa6e0dc37316bd35f1f22154cb3fbf0014bbec.png b/_images/8299fbb1369ab8adbd2606465eaa6e0dc37316bd35f1f22154cb3fbf0014bbec.png
diff --git a/_images/8862c8b1541aadb10218a80a471ade61d437d97e1a3a11fbfd99b58ff7108800.png b/_images/8862c8b1541aadb10218a80a471ade61d437d97e1a3a11fbfd99b58ff7108800.png
diff --git a/_images/8c441e107ceb50326396d4ed205221308210df7b9dafb36c7460602bb8513d61.png b/_images/8c441e107ceb50326396d4ed205221308210df7b9dafb36c7460602bb8513d61.png
diff --git a/_images/9a871a4075bc2d49c83d43b924c85eb6f694001a9e1b7415cf136e5a969c632a.png b/_images/9a871a4075bc2d49c83d43b924c85eb6f694001a9e1b7415cf136e5a969c632a.png
diff --git a/_images/a58f4c19849c45c922ac6903db3f1724a0d7a173df135e19e6d1f97ae06bb00f.png b/_images/a58f4c19849c45c922ac6903db3f1724a0d7a173df135e19e6d1f97ae06bb00f.png
diff --git a/_images/ad92e8fda8c524876d3e091ce73714f1f3ee5b1d23c6b1087998443a157aaed5.png b/_images/ad92e8fda8c524876d3e091ce73714f1f3ee5b1d23c6b1087998443a157aaed5.png
diff --git a/_images/b09df3c023016fea745da6cef7b9f2682fb6a5597ad8e55845f582f6cf0eb96a.png b/_images/b09df3c023016fea745da6cef7b9f2682fb6a5597ad8e55845f582f6cf0eb96a.png
diff --git a/_images/c42e23f1fe6bc999749750b20fb55cf791bedf8c43705e30e70937ae8af283ec.png b/_images/c42e23f1fe6bc999749750b20fb55cf791bedf8c43705e30e70937ae8af283ec.png
diff --git a/_images/cb111449b8ae1bc9acbda78b3292de81bb1ade6555c3f3ae2f9cb78ac2665e00.png b/_images/cb111449b8ae1bc9acbda78b3292de81bb1ade6555c3f3ae2f9cb78ac2665e00.png
diff --git a/_images/e735c5d874309622476e3ef04dc2e7fb084e2423db7e9e02c9502ca23915c395.png b/_images/e735c5d874309622476e3ef04dc2e7fb084e2423db7e9e02c9502ca23915c395.png
diff --git a/_images/f2e48d327d5a848ae8d67ab1b5dd3cd3a0d6e121217d067f4e3515b3bd9b3d48.png b/_images/f2e48d327d5a848ae8d67ab1b5dd3cd3a0d6e121217d067f4e3515b3bd9b3d48.png
diff --git a/_sources/api_exsys.rst b/_sources/api_exsys.rst
@@ -5,8 +5,30 @@ Expression system
 
 .. currentmodule:: heyoka
 
+Classes
+-------
+
 .. autosummary::
    :toctree: autosummary_generated
+   :template: custom-class-template.rst
 
    expression
+   dtens
+
+Functions
+---------
+
+.. autosummary::
+   :toctree: autosummary_generated
+
    make_vars
+   diff_tensors
+
+Enums
+-----
+
+.. autosummary::
+   :toctree: autosummary_generated
+   :template: custom-enum-template.rst
+
+   diff_args
diff --git a/_sources/autosummary_generated/heyoka.diff_args.rst b/_sources/autosummary_generated/heyoka.diff_args.rst
@@ -0,0 +1,6 @@
+heyoka.diff\_args
+=================
+
+.. currentmodule:: heyoka
+
+.. autoclass:: diff_args
diff --git a/_sources/autosummary_generated/heyoka.diff_tensors.rst b/_sources/autosummary_generated/heyoka.diff_tensors.rst
@@ -0,0 +1,6 @@
+heyoka.diff\_tensors
+====================
+
+.. currentmodule:: heyoka
+
+.. autofunction:: diff_tensors
diff --git a/_sources/autosummary_generated/heyoka.dtens.rst b/_sources/autosummary_generated/heyoka.dtens.rst
@@ -0,0 +1,35 @@
+heyoka.dtens
+============
+
+.. currentmodule:: heyoka
+
+.. autoclass:: dtens
+   :members:
+   :special-members: __init__
+
+
+
+   .. rubric:: Methods
+
+   .. autosummary::
+
+      ~dtens.__init__
+      ~dtens.get_derivatives
+      ~dtens.index_of
+
+
+
+
+
+   .. rubric:: Attributes
+
+   .. autosummary::
+
+      ~dtens.args
+      ~dtens.gradient
+      ~dtens.jacobian
+      ~dtens.nargs
+      ~dtens.nouts
+      ~dtens.order
+
+
diff --git a/_sources/autosummary_generated/heyoka.expression.rst b/_sources/autosummary_generated/heyoka.expression.rst
@@ -4,10 +4,10 @@
 .. currentmodule:: heyoka
 
 .. autoclass:: expression
+   :members:
+   :special-members: __init__
 
 
-   .. automethod:: __init__
-
 
    .. rubric:: Methods
 

diff --git a/_sources/breaking_changes.rst b/_sources/breaking_changes.rst
@@ -24,7 +24,9 @@ input arguments, turned out to be in practice confusing and a source of bugs.
 The affected APIs include:
 
 - :ref:`compiled functions <cfunc_tut>`, which now require the list of input
-  variables to be always supplied by the user.
+  variables to be always supplied by the user;
+- :func:`~heyoka.diff_tensors()`, which now requires an explicit list of differentiation
+  arguments to be always provided by the user.
 
 The tutorials and the documentation have been updated accordingly.
 

diff --git a/_sources/changelog.rst b/_sources/changelog.rst
@@ -25,6 +25,10 @@ New
 Changes
 ~~~~~~~
 
+- **BREAKING**: it is now mandatory to supply a list of differentiation
+  arguments to :func:`~heyoka.diff_tensors()`
+  (`#164 <https://github.com/bluescarni/heyoka.py/pull/164>`__).
+  This is a :ref:`breaking change <bchanges_4_0_0>`.
 - **BREAKING**: :ref:`compiled functions <cfunc_tut>` now require
   the list of input variables to be always supplied by the user
   (`#162 <https://github.com/bluescarni/heyoka.py/pull/162>`__).

diff --git a/_sources/index.md b/_sources/index.md
@@ -104,7 +104,7 @@ examples_others
 :maxdepth: 2
 :caption: API reference
 
-api_integrators
 api_exsys
+api_integrators
 api_lagham
 ```