summaryrefslogtreecommitdiff
path: root/src/python/doc
diff options
context:
space:
mode:
authorHind-M <hind.montassif@gmail.com>2022-05-24 11:44:49 +0200
committerHind-M <hind.montassif@gmail.com>2022-05-24 11:44:49 +0200
commitdcd4204d62a4c9a4f3d9ebc61341fba25ae19687 (patch)
tree8787056d20d39c1d288fda59d6343dc3621378dc /src/python/doc
parent79495423a0a0ffaa30dbd06ff1a5468ba2839726 (diff)
Use autofunction instead of automodule in doc and add 2d spiral image
Diffstat (limited to 'src/python/doc')
-rw-r--r--src/python/doc/datasets.rst16
-rw-r--r--src/python/doc/img/spiral_2d.pngbin0 -> 279276 bytes
2 files changed, 12 insertions, 4 deletions
diff --git a/src/python/doc/datasets.rst b/src/python/doc/datasets.rst
index 62b7dca0..d2975533 100644
--- a/src/python/doc/datasets.rst
+++ b/src/python/doc/datasets.rst
@@ -112,13 +112,21 @@ Fetching datasets
We provide some ready-to-use datasets that are not available by default when getting GUDHI, and need to be fetched explicitly.
+.. autofunction:: gudhi.datasets.remote.fetch_bunny
+
.. figure:: ./img/bunny.png
:figclass: align-center
3D Stanford bunny with 35947 vertices.
-.. automodule:: gudhi.datasets.remote
- :members:
- :special-members:
- :show-inheritance:
+.. autofunction:: gudhi.datasets.remote.fetch_spiral_2d
+
+.. figure:: ./img/spiral_2d.png
+ :figclass: align-center
+
+ 2D spiral with 114562 vertices.
+
+.. autofunction:: gudhi.datasets.remote.get_data_home
+
+.. autofunction:: gudhi.datasets.remote.clear_data_home
diff --git a/src/python/doc/img/spiral_2d.png b/src/python/doc/img/spiral_2d.png
new file mode 100644
index 00000000..abd247cd
--- /dev/null
+++ b/src/python/doc/img/spiral_2d.png
Binary files differ