Skip to content

Commit 1dafb97

Browse files
committed
chore(docs): clarify docs build call and graphviz render note
1 parent 3e45ec0 commit 1dafb97

File tree

2 files changed

+6
-2
lines changed

2 files changed

+6
-2
lines changed

docs/README.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,9 @@ It is volume-mounted to emit `docs/_build/html/index.html`
1313
For generating all types used in production, e.g., epub and pdf as well, mimic the CI runner:
1414

1515
```bash
16-
docs $ ./ci.sh
16+
docs $ ./ci.sh
17+
# or from repo root with an explicit format:
18+
DOCS_FORMAT=html ./docs/ci.sh
1719
```
1820

1921
## Architecture
@@ -71,4 +73,3 @@ Notebook validation is enabled by default. To disable: `VALIDATE_NOTEBOOK_EXECUT
7173
- Rerun `cd docs && ./ci.sh` to see the changes, with the benefit of docker & sphinx incremental builds
7274

7375
- Check your results in `docs/_build/html/index.html` or the equivalent epub and pdf files
74-

graphistry/plugins/graphviz.py

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -334,6 +334,9 @@ def render_graphviz(
334334
This wraps :func:`layout_graphviz_core` to compute positions, then draws with pygraphviz.
335335
Optionally enforces caps to keep renders small/deterministic for docs/examples.
336336
337+
When ``include_positions`` is True and the plot has bound x/y values, the existing layout
338+
is preserved rather than recomputed by Graphviz.
339+
337340
:param self: Base graph
338341
:type self: Plottable
339342
:param prog: Layout algorithm

0 commit comments

Comments
 (0)