Skip to content

Commit 297beec

Browse files
committed
Add warnings in the doc about the deprecation of treeview.
Well, kind of deprecation. Tell the users that we expect them to use smartview instead.
1 parent f5186b6 commit 297beec

File tree

2 files changed

+26
-0
lines changed

2 files changed

+26
-0
lines changed

doc/reference/reference_treeview.rst

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,19 @@
11
.. module:: treeview
22
.. currentmodule:: ete4.treeview
33

4+
.. note::
5+
6+
Since ETE 4, the treeview module is **not** the preferred way to
7+
create visualizations. This module is a port of the old
8+
visualization in ETE, and we have maintained it, but recommend
9+
instead to use the web visualization (:class:`smartview module
10+
<ete4.smartview>`).
11+
12+
This module has less functionality and will not be generally
13+
updated. Also, please note that the way it uses faces and layouts is
14+
incompatible with the way smartview uses them.
15+
16+
417
Treeview (qt graphics)
518
======================
619

doc/tutorial/tutorial_treeview.rst

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,18 @@
11
.. currentmodule:: ete4.treeview
22

3+
.. note::
4+
5+
Since ETE 4, the treeview module is **not** the preferred way to
6+
create visualizations. This module is a port of the old
7+
visualization in ETE, and we have maintained it, but recommend
8+
instead to use the web visualization (:class:`smartview module
9+
<ete4.smartview>`).
10+
11+
This module has less functionality and will not be generally
12+
updated. Also, please note that the way it uses faces and layouts is
13+
incompatible with the way smartview uses them.
14+
15+
316
Tree drawing (Qt)
417
=================
518

0 commit comments

Comments
 (0)