docs: Add graphviz examples across documentation #864
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
lmeyerov
force-pushed
the
feat/graphviz-docs-usage
branch
4 times, most recently
from
e460ce6 to
76844d4
Compare
Add rich graphviz diagrams to documentation pages: - 10min.rst - intro visualization example - visualization/10min.rst - layout pipeline diagram - ecosystem.rst - ecosystem overview - gfql/overview.rst - GFQL flow diagram - gfql/quick.rst - quick start example - graphistry.layout.rst - layout options Builds on infrastructure from base PR #859. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <[email protected]>
Phase 4.C documents: - Audit of all GFQL rst/md files for graphviz opportunities - Strategy: use graphviz only for small illustrative patterns (5-10 nodes) - Keep df samples and g.plot() for big data / interactive viz demos - Specific diagram recommendations for about.rst and translate.rst 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <[email protected]>
Phase 4.D documents:
- Non-GFQL docs audit (10min, visualization, ecosystem, cheatsheet)
- RST→Notebook conversion candidates:
- gfql/about.rst (high priority - flagship intro)
- gfql/translate.rst (medium - query patterns)
- visualization/layout/catalog.rst (medium - layout outputs)
- Key insight: .plot() for interactive → keep RST + add diagrams
pattern examples → convert to notebook with plot_static()
🤖 Generated with [Claude Code](https://claude.com/claude-code)
Co-Authored-By: Claude <[email protected]>
- about.rst: +4 diagrams (2-hop traversal, labeled hops, risk pattern, let DAG) - translate.rst: +4 diagrams (node filter, person→company, multi-hop, all-paths) Diagrams use .. graphviz:: directive rendered by sphinx.ext.graphviz
Single backticks in RST render as italics, not code. Fixed inline code references across GFQL and visualization docs. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <[email protected]>
- Replace disconnected "Static Graphviz example" with meaningful sample dataset that matches what the examples use (person/company/transaction nodes, risk flags, interesting edges) - Convert print statements to inline comments showing expected values - Removes distracting prints that had no visible output in static docs 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <[email protected]>
- Example 1: Show n() returns only filtered nodes (persons highlighted, others grayed out) - Example 5: Show is_in pattern with clustered node groups and forward/reverse traversal arrows 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <[email protected]>
Missed a few Objective lines in the previous backtick fix. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <[email protected]>
- Use option3_v3 style: bold green for returned nodes, solid gray fill for filtered nodes - Update all diagrams to use consistent color scheme: - Person nodes: #87CEEB (sky blue) - Company nodes: #FFFACD (lemon yellow) - Transaction/risk nodes: #FFB6C1 (light pink) - Returned/highlighted: #90EE90 (light green) with bold border - Filtered out: #D3D3D3 (light gray) - Add penwidth and bold styling for better contrast 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <[email protected]>
Use same color scheme as about.rst: - Person nodes: #87CEEB (sky blue) - Company nodes: #FFFACD (lemon yellow) - Result/highlighted: #90EE90 (light green) with bold - Filtered/intermediate: #D3D3D3 (light gray) - All nodes now have filled backgrounds and bold borders 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <[email protected]>
🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <[email protected]>
The arbitrary a->b->c->d diagram with unexplained coloring was misleading. Other diagrams use type labels and filter semantics to justify their coloring - this one had none. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <[email protected]>
Remove explicit SVG() wrapper from examples - plot_static now auto-displays inline in Jupyter notebooks. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <[email protected]>
lmeyerov
force-pushed
the
feat/graphviz-docs-usage
branch
from
76844d4 to
98b9309
Compare
plans/ directory is private and already in .gitignore 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <[email protected]>
- Add static_rendering.ipynb: comprehensive tutorial covering: - Output formats (SVG, PNG, DOT, Mermaid) - Common styling options (graph_attr, node_attr, edge_attr) - How to find more configuration options (PyGraphistry types + graphviz.org) - Per-node/per-edge data-driven styling - Layout programs (dot, neato, circo, etc.) - Reusing positions from other layouts (UMAP, ring, manual) - Saving output and CI pipeline patterns - Refocus graphviz.ipynb on layout (not rendering): - Update title to "Graphviz Layouts for Graphistry Visualization" - Add See Also section linking to static_rendering.ipynb - Clarify notebook is about layout + interactive Graphistry viz - Add Static Image Export sections to: - docs/source/10min.rst - docs/source/visualization/10min.rst - docs/source/visualization/index.rst - docs/source/visualization/layout/catalog.rst (under Graphviz Plugin) - Expand docs/source/api/plugins/compute/graphviz.rst with styling example - Add note to docs/source/gfql/about.rst explaining sphinx diagrams vs plot_static() - Reorder notebooks/plugins.compute.rst toctree to feature Static Rendering first - Remove plot_static_demo.ipynb (superseded by static_rendering.ipynb) 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <[email protected]>
The notebook now contains executed cells with SVG outputs so they display correctly on ReadTheDocs (which uses nbsphinx_execute = 'never'). 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
Add rich graphviz examples across documentation pages, building on the infrastructure from #859.
Pages with new graphviz diagrams:
docs/source/10min.rst- intro visualization exampledocs/source/visualization/10min.rst- layout pipeline diagramdocs/source/ecosystem.rst- ecosystem overviewdocs/source/gfql/overview.rst- GFQL flow diagramdocs/source/gfql/quick.rst- quick start exampledocs/source/graphistry.layout.rst- layout optionsDependencies
Test plan
🤖 Generated with Claude Code