Skip to content

Add pyvis html render to documentation #394

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
kayjan merged 1 commit into from
Jul 31, 2025
Merged

Add pyvis html render to documentation #394

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
1 change: 1 addition & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
## [Unreleased]
### Added:
- Tree Render: `render_tree` to accept theme argument.
- Docs: Add pyvis html render to Tree Demonstration.

## [0.29.2] - 2025-05-15
### Added:
Expand Down
13 changes: 12 additions & 1 deletion docs/gettingstarted/demo/tree.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -343,7 +343,7 @@ After tree is constructed, it can be viewed by printing to console using `show`,
for compact, horizontal, and vertical orientation respectively.
Alternatively, the `print_tree`, `hprint_tree`, or `vprint_tree` method can be used.

```python hl_lines="8 15"
```python hl_lines="8 15 21"
from bigtree import Node, print_tree, hprint_tree, vprint_tree

root = Node("a", alias="alias-a", age=90, gender="F")
Expand Down Expand Up @@ -1372,3 +1372,14 @@ flowchart TB
0("a") --> 0-1("c")
classDef default stroke-width:1
```

- Pyvis network

<div style="background-color: white;">
<script src="https://cdnjs.cloudflare.com/ajax/libs/vis-network/9.1.2/dist/vis-network.min.js" integrity="sha512-LnvoEWDFrqGHlHmDD2101OrLcbsfkrzoSpvtSQtxK3RMnRV0eOkhhBN2dXHKRrUU8p2DGRTk35n4O8nWSVe1mQ==" crossorigin="anonymous" referrerpolicy="no-referrer"></script>
{%
include-markdown "../../../assets/demo/vis.html"
start="<body>"
end="</body>"
%}
</div>
1 change: 1 addition & 0 deletions docs/requirements.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ IPython
mdx_truly_sane_lists==1.3
mkdocs==1.5.3
mkdocs-glightbox==0.3.7
mkdocs-include-markdown-plugin
mkdocs-jupyter
mkdocs-material[imaging]==9.5.17
mkdocstrings[python]>=0.25.0 # griffe.collections error
Expand Down
1 change: 1 addition & 0 deletions mkdocs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -104,6 +104,7 @@ plugins:
- mkdocs-jupyter:
ignore_h1_titles: True
- search
- include-markdown
- social:
cards_layout_options:
logo: docs/_static/favicon.svg
Expand Down
1 change: 1 addition & 0 deletions pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -113,6 +113,7 @@ dependencies = [
"IPython",
"mkdocs==1.5.3",
"mkdocs-glightbox",
"mkdocs-include-markdown-plugin",
"mkdocs-jupyter",
"mkdocs-material[imaging]==9.5.17",
"mdx_truly_sane_lists==1.3",
Expand Down
Loading