Skip to content

Commit

Permalink
Update installation docs
Browse files Browse the repository at this point in the history
  • Loading branch information
mar10 committed Sep 12, 2024
1 parent a98fd14 commit 0a29306
Show file tree
Hide file tree
Showing 5 changed files with 9 additions and 31 deletions.
4 changes: 2 additions & 2 deletions docs/sphinx/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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.

::

Expand Down
4 changes: 2 additions & 2 deletions docs/sphinx/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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::
Expand Down
6 changes: 3 additions & 3 deletions docs/sphinx/ug_graphs.rst
Original file line number Diff line number Diff line change
Expand Up @@ -175,7 +175,7 @@ Let's visualize the result of the :ref:`diff-and-merge` example::
of `pydot <https://github.com/pydot/pydot>`_
and `Graphwiz <https://www.graphviz.org>`_. |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:

Expand Down Expand Up @@ -461,5 +461,5 @@ This would be the 'turtle' formatted serialization::

.. note::
Converting to RDF requires an installation of `rdflib <https://rdflib.readthedocs.io/>`_ |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]"``.
2 changes: 2 additions & 0 deletions docs/sphinx/ug_randomize.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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]"``.
24 changes: 0 additions & 24 deletions setup.cfg
Original file line number Diff line number Diff line change
Expand Up @@ -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

0 comments on commit 0a29306

Please sign in to comment.