Skip to content

Commit de4c3c8

Browse files
committed
Update contributing docs for flowcharts
1 parent 2d53d4a commit de4c3c8

File tree

1 file changed

+6
-3
lines changed

1 file changed

+6
-3
lines changed

CONTRIBUTING.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -112,12 +112,15 @@ Steps to build this documentation locally:
112112
```
113113

114114
where `{width}` and `{height}` are the values already present in the existing `width` and `height` XML attributes.
115-
- Load SVGs in HTML `object` elements with the `raw:: html` directive to preserve hyperlinks and scaling:
115+
- Embed SVGs with the `raw:: html` directive to preserve hyperlinks. Since the `svg-flowchart` container scales SVGs to the page width, add a link below to view them at their original scale:
116116

117117
```rst
118-
.. raw:: html
118+
.. container:: svg-flowchart
119119
120-
<object data="../_static/path/to/chart.svg" type="image/svg+xml"></object>
120+
.. raw:: html
121+
:file: ../_static/path/to/chart.svg
122+
123+
`Open image <../_static/path/to/chart.svg>`_
121124
```
122125

123126
<a id="markdown-tutorials" name="tutorials"></a>

0 commit comments

Comments
 (0)