Repository navigation
docs: make the mermaid diagrams readable (#1103) - #1819
Merged
Merged
Conversation
- conf.py: render each diagram at its natural size, shrunk only to the page width, and centre one narrower than the page; the plugin default fitted every SVG into a fixed 500px box, so tall graphs shrank until text and edges ran together - click targets: page-relative, since the site is served under /PyPCAPKit/ and a root-absolute target 404s there - workflows: split direct triggers from the workflow-to-workflow edges, one schedule node per day; say which triggers run each gate-only call - protocols: declare the layers so ARP --> RARP and Raw --> FTP_DATA no longer run through other layers' nodes - engines, releasing, registry-protocol: stack the subgraphs, and order or merge edges so none cross; mint-criterion: LR, monotoneX curves - escape _missing_, _member_map_ and __version__, which Mermaid read as Markdown emphasis - documentation.rst: direction, escape and click-target rules match Full clean build: no new warnings; tests/project pass. Refs #1103
Owner
Author
|
Verdict: GOOD TO GO at |
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
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.
Please follow the guide below
You will be asked some questions, please read them carefully and answer honestly
Put an
xinto all the boxes [ ] relevant to your pull request (like that [x])Use Preview tab to see how your pull request will actually look like
Searched for similar pull requests
Followed the coding style (
make pylint,make mypy,make isort)make testpasses, and a test case covers the change. Narrow runs only, listed below.Added a changelog entry under
docs/source/changelog/and regeneratedCHANGELOG.md, if the change is user-visible: N/A — centralised in docs(changelog): shared 1.5.0 changelog — long-lived, merges last (#610, #616, #617, #618, #620) #657What is the purpose of your pull request?
Tick the commit type your subject line carries.
fix— corrects a defectfeat— adds a featureperf— changes performance, not behaviourrefactor— changes neither behaviour nor performancetest— tests onlydocs— documentation onlyci— workflows or build toolingrelease— bumps the version or rolls up a distributionchore— anything elseDescription
Refs #1103 (rendered-docs proofread). The user saw tangled, unreadable Mermaid graphs on the docs site.
sphinxcontrib-mermaiddefaults fit every SVG into a fixed 500px box. On the page the protocol hierarchy rendered at 0.14x and the field hierarchy at 0.19x, so text and edges ran together.conf.pynow renders each diagram at its natural size, shrunk only to the page width;_static/mermaid.csscentres narrow ones._missing_,_member_map_and__version__are escaped.clicktargets were root-absolute and 404 under the site's/PyPCAPKit/prefix. They are now page-relative, and every local target resolves to a 200 with its anchor present (headless Chrome, served under the prefix).workflows.rstnow states which triggers run each gate-only call. The old "only on the Saturday schedule path" was wrong for Create Release, which runs on av*tag push.documentation.rstgains the escape and click-target rules.Rejected on measurement: ELK layout (wider, reorders siblings) and tighter spacing (only 10–15% narrower). Not fixed: a few edges still run under labels in the two workflows graphs (far fewer than before); no variant tried cleared the chain graph's without adding crossings.
Checks: clean
-Ebuilds ofmainand this head give the same warnings by (page, message).tests/project: 950 passed, 1 skipped.test_workflows_at_a_glance_1732.pyalso passes merged with #1817, which edits that test.