From 0a293067c9bb8e6cf1386ec71935db520faaabf8 Mon Sep 17 00:00:00 2001 From: Martin Wendt Date: Thu, 12 Sep 2024 14:07:06 +0200 Subject: [PATCH] Update installation docs --- docs/sphinx/index.rst | 4 ++-- docs/sphinx/installation.rst | 4 ++-- docs/sphinx/ug_graphs.rst | 6 +++--- docs/sphinx/ug_randomize.rst | 2 ++ setup.cfg | 24 ------------------------ 5 files changed, 9 insertions(+), 31 deletions(-) diff --git a/docs/sphinx/index.rst b/docs/sphinx/index.rst index 351651f..e73b854 100644 --- a/docs/sphinx/index.rst +++ b/docs/sphinx/index.rst @@ -28,8 +28,8 @@ nutree $ pip install nutree -**Note:** Run ``pip install nutree[graph]`` instead, in order to install -additional graph support. +**Note:** Run ``pip install "nutree[graph]"`` or ``pip install "nutree[all]"`` +instead, in order to install additional graph support. :: diff --git a/docs/sphinx/installation.rst b/docs/sphinx/installation.rst index 61d0120..b37cd23 100644 --- a/docs/sphinx/installation.rst +++ b/docs/sphinx/installation.rst @@ -5,8 +5,8 @@ Installation is straightforward:: $ pip install nutree -**Note:** Run ``pip install nutree[graph]`` instead, in order to install -additional graph support. +**Note:** Run ``pip install "nutree[graph]"`` or ``pip install "nutree[all]"`` +instead, in order to install additional graph support. Installing `nutree` and its dependencies into a 'sandbox' will help to keep your system Python clean, but requires to activate the virtual environment:: diff --git a/docs/sphinx/ug_graphs.rst b/docs/sphinx/ug_graphs.rst index 2330b76..27fbd7d 100644 --- a/docs/sphinx/ug_graphs.rst +++ b/docs/sphinx/ug_graphs.rst @@ -175,7 +175,7 @@ Let's visualize the result of the :ref:`diff-and-merge` example:: of `pydot `_ and `Graphwiz `_. |br| Either install them separately or install nutree with extras: - ``pip install nutree[graph]``. + ``pip install "nutree[graph]"`` or ``pip install "nutree[all]"``. .. _save-mermaid: @@ -461,5 +461,5 @@ This would be the 'turtle' formatted serialization:: .. note:: Converting to RDF requires an installation of `rdflib `_ |br| - Either install it separately or install nutree with extras: - ``pip install nutree[graph]``. + Either install them separately or install nutree with extras: + ``pip install "nutree[graph]"`` or ``pip install "nutree[all]"``. diff --git a/docs/sphinx/ug_randomize.rst b/docs/sphinx/ug_randomize.rst index d0d6260..e52daf2 100644 --- a/docs/sphinx/ug_randomize.rst +++ b/docs/sphinx/ug_randomize.rst @@ -170,3 +170,5 @@ May produce:: library and can use any of its providers to generate random data. |br| Make sure to install the `fabulist` package to use the text randomizers :class:`~tree_generator.TextRandomizer` and :class:`~tree_generator.BlindTextRandomizer`. + Either install `fabulist` separately or install nutree with extras: + ``pip install "nutree[random]"`` or ``pip install "nutree[all]"``. diff --git a/setup.cfg b/setup.cfg index 44abd57..664ebe8 100644 --- a/setup.cfg +++ b/setup.cfg @@ -102,27 +102,3 @@ universal = false # ignore = # docs/sphinx-build # docs/sphinx-build/* - -# # --- Coverage Settings -------------------------------------------------------- - -# [coverage:run] -# # branch = True -# omit = -# tests/* -# # nutree/leaves_cli.py -# # nutree/cli_common.py -# # nutree/monitor/* - -# [coverage:report] -# precision = 1 -# # show_missing = True -# sort = Name -# exclude_lines = -# pragma: no cover -# raise NotImplementedError -# if __name__ == .__main__.: -# if TYPE_CHECKING: - -# [coverage:html] -# directory = build/coverage -