Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions docs/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,20 +10,25 @@ There are two ways to install `bigtree`, with pip (recommended) or conda.

To install `bigtree`, run the following line in command prompt:

<!-- termynal -->
```console
$ pip install bigtree
---> 100%
Installed
```

If tree needs to use pandas methods, it requires additional dependencies.
Run the following line in command prompt:

<!-- termynal -->
```console
$ pip install 'bigtree[pandas]'
```

If tree needs to be exported to image, it requires additional dependencies.
Run the following lines in command prompt:

<!-- termynal -->
```console
$ pip install 'bigtree[image]'
$ brew install gprof2dot # for MacOS
Expand All @@ -32,6 +37,7 @@ $ conda install graphviz # for Windows

Alternatively, install all optional dependencies with the following line in command prompt:

<!-- termynal -->
```console
$ pip install 'bigtree[all]'
```
Expand All @@ -40,6 +46,7 @@ $ pip install 'bigtree[all]'

To install `bigtree` with conda, run the following line in command prompt:

<!-- termynal -->
```console
$ conda install -c conda-forge bigtree
```
1 change: 1 addition & 0 deletions docs/requirements.txt
Original file line number Diff line number Diff line change
Expand Up @@ -7,3 +7,4 @@ mkdocstrings[python]==0.24.0
pandas
Pillow
pydot
termynal==0.11.1
4 changes: 4 additions & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -113,6 +113,10 @@ plugins:
merge_init_into_class: true
docstring_section_style: table
signature_crossrefs: true
- termynal:
prompt_literal_start:
- "$"
- ">"

extra:
social:
Expand Down
1 change: 1 addition & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -96,6 +96,7 @@ dependencies = [
"mkdocs-material[imaging]==9.5.5",
"mdx_truly_sane_lists",
"mkdocstrings[python]",
"termynal",
"black",
"IPython",
"pandas",
Expand Down