Skip to content

Commit

Permalink
Deployed d9d7f98 with MkDocs version: 1.6.0
Browse files Browse the repository at this point in the history
  • Loading branch information
MerrimanInd committed Sep 25, 2024
1 parent 4717290 commit 11a8d31
Show file tree
Hide file tree
Showing 7 changed files with 51 additions and 28 deletions.
Binary file added img/edge_styles/line_end_none.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 2 additions & 2 deletions index.html
Original file line number Diff line number Diff line change
Expand Up @@ -914,9 +914,9 @@ <h1 id="welcome-to-drawpyo">Welcome to drawpyo</h1>
<p>Drawpyo is a Python library for programmatically generating <a href="https://www.drawio.com/">Draw.io</a> charts. It enables creating a diagram object, placing and styling objects, then writing the object to a file.</p>
<h1 id="historyjustification">History/Justification</h1>
<p>I love Draw.io! Compared to expensive and heavy commercial options like Visio and Miro, Draw.io's free and lightweight app allows wider and more universal distribution of diagrams. Because the files are stored in plaintext they can be versioned alongside code in a repository as documentation. Draw.io also maintains backwards compatibility and any diagram created in the app since it was launched can still be opened. The XML-based file format makes these diagrams semi-portable, and could easily be ported to other applications if Draw.io ever disappeared. For these reason, I think it's one of the best options for documentation diagrams.</p>
<p>So when I had a need to generate hierarchical tree diagrams of requirement structures I looked to Draw.io but I was surprised to find there wasn't even a single existing Python library for working with these files. I took the project home and spent a weekend building the initial functionality. I've been adding functionality, robustness, and documentation intermittently since.</p>
<p>So when I had a need to generate hierarchical tree diagrams of requirement structures I looked to Draw.io but I was surprised to find there wasn't even a single existing Python library for working with these files. I took the project home and spent a weekend building the initial functionality. I've been adding features, robustness, and documentation intermittently since.</p>
<h1 id="the-future-of-drawpyo">The Future of Drawpyo</h1>
<p>I will continue to tinker away with this tool, creating new functionality as I need it or find it interesting. But it's unfortunately a rather low priority so if anyone wants to contribute I would be grateful for the help! Reach out to me at <a href="mailto:xander@merriman.industries">xander@merriman.industries</a> if you want to contribute.</p>
<p>I will continue to tinker away with this tool, creating new functionality as I need it or find it interesting. But it's unfortunately a rather low priority so if anyone wants to contribute I would be grateful for the help! Reach out to me at <a href="mailto:xander@merriman.industries">xander@merriman.industries</a> if you want to help.</p>



Expand Down
2 changes: 1 addition & 1 deletion search/search_index.json

Large diffs are not rendered by default.

38 changes: 19 additions & 19 deletions sitemap.xml
Original file line number Diff line number Diff line change
Expand Up @@ -2,97 +2,97 @@
<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
<url>
<loc>https://merrimanind.github.io/drawpyo/</loc>
<lastmod>2024-08-13</lastmod>
<lastmod>2024-09-25</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://merrimanind.github.io/drawpyo/about/</loc>
<lastmod>2024-08-13</lastmod>
<lastmod>2024-09-25</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://merrimanind.github.io/drawpyo/api/architecture/</loc>
<lastmod>2024-08-13</lastmod>
<lastmod>2024-09-25</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://merrimanind.github.io/drawpyo/api/edges/</loc>
<lastmod>2024-08-13</lastmod>
<lastmod>2024-09-25</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://merrimanind.github.io/drawpyo/api/extended_objects/</loc>
<lastmod>2024-08-13</lastmod>
<lastmod>2024-09-25</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://merrimanind.github.io/drawpyo/api/file/</loc>
<lastmod>2024-08-13</lastmod>
<lastmod>2024-09-25</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://merrimanind.github.io/drawpyo/api/objects/</loc>
<lastmod>2024-08-13</lastmod>
<lastmod>2024-09-25</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://merrimanind.github.io/drawpyo/api/page/</loc>
<lastmod>2024-08-13</lastmod>
<lastmod>2024-09-25</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://merrimanind.github.io/drawpyo/api/text_format/</loc>
<lastmod>2024-08-13</lastmod>
<lastmod>2024-09-25</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://merrimanind.github.io/drawpyo/api/tree_diagram/nodeobject/</loc>
<lastmod>2024-08-13</lastmod>
<lastmod>2024-09-25</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://merrimanind.github.io/drawpyo/api/tree_diagram/treediagram/</loc>
<lastmod>2024-08-13</lastmod>
<lastmod>2024-09-25</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://merrimanind.github.io/drawpyo/diagram_types/tree_diagrams/</loc>
<lastmod>2024-08-13</lastmod>
<lastmod>2024-09-25</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://merrimanind.github.io/drawpyo/usage/basic_usage/</loc>
<lastmod>2024-08-13</lastmod>
<lastmod>2024-09-25</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://merrimanind.github.io/drawpyo/usage/edges/</loc>
<lastmod>2024-08-13</lastmod>
<lastmod>2024-09-25</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://merrimanind.github.io/drawpyo/usage/extended_objects/</loc>
<lastmod>2024-08-13</lastmod>
<lastmod>2024-09-25</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://merrimanind.github.io/drawpyo/usage/objects/</loc>
<lastmod>2024-08-13</lastmod>
<lastmod>2024-09-25</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://merrimanind.github.io/drawpyo/usage/parent_child_objects/</loc>
<lastmod>2024-08-13</lastmod>
<lastmod>2024-09-25</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://merrimanind.github.io/drawpyo/usage/shape_libs/</loc>
<lastmod>2024-08-13</lastmod>
<lastmod>2024-09-25</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://merrimanind.github.io/drawpyo/usage/text_format/</loc>
<lastmod>2024-08-13</lastmod>
<lastmod>2024-09-25</lastmod>
<changefreq>daily</changefreq>
</url>
</urlset>
Binary file modified sitemap.xml.gz
Binary file not shown.
29 changes: 23 additions & 6 deletions usage/basic_usage/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -1094,12 +1094,29 @@ <h3 id="make-a-new-file">Make a new file</h3>
file.file_name = &quot;Test Generated Edges.drawio&quot;
</code></pre>
<h3 id="write-a-file">Write a file</h3>
<p>Files can be written simply with the write() function. This function takes a few parameters to make it more flexible:
| Parameter | Setting |
| - | - |
| <code>file_path</code> | This will overwrite the previously set file_path. |
| <code>file_name</code> | This will overwrite the previously set file_name. Like file_path, useful in creating multiple copies of a diagram with slight variations |
| <code>overwrite</code> | This boolean parameter controls whether an existing diagram should be overwritten or not. |</p>
<p>Files can be written simply with the write() function. This function takes a few parameters to make it more flexible:</p>
<table>
<thead>
<tr>
<th>Parameter</th>
<th>Setting</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>file_path</code></td>
<td>This will overwrite the previously set file_path.</td>
</tr>
<tr>
<td><code>file_name</code></td>
<td>This will overwrite the previously set file_name. Like file_path, useful in creating multiple copies of a diagram with slight variations</td>
</tr>
<tr>
<td><code>overwrite</code></td>
<td>This boolean parameter controls whether an existing diagram should be overwritten or not.</td>
</tr>
</tbody>
</table>
<h2 id="pages">Pages</h2>
<h2 id="add-a-page">Add a page</h2>
<p>The Page object represents the different diagram pages that you can create in Draw.io. A Page can be created without linking it to a File but it won't be writable without a File object.</p>
Expand Down
6 changes: 6 additions & 0 deletions usage/edges/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -1580,6 +1580,7 @@ <h3 id="patterns">Patterns</h3>
</table>
<h3 id="line-ends">Line Ends</h3>
<p>The <code>line_end_target</code> and <code>line_end_source</code> parameter sets whatever is rendered where the edge meets the objects. There are secondary boolean parameters for the fill of the ends (<code>endFill_target</code> and <code>endFill_source</code>) but not all ends can be filled.</p>
<p>To remove line ends and just have a bare line set the parameter to the text string <code>'none'</code>.</p>
<p>The line end size can also be adjusted with <code>endSize</code> and <code>startSize</code> parameters, both set in points.</p>
<table>
<thead>
Expand All @@ -1596,6 +1597,11 @@ <h3 id="line-ends">Line Ends</h3>
<td><em>na</em></td>
</tr>
<tr>
<td><code>none</code></td>
<td><img alt="line_end_none" src="../../img/edge_styles/line_end_none.png" /></td>
<td><em>na</em></td>
</tr>
<tr>
<td><code>classic</code></td>
<td><img alt="line_end_classic" src="../../img/edge_styles/line_end_classic.png" /></td>
<td><img alt="line_end_classic_filled" src="../../img/edge_styles/line_end_classic_filled.png" /></td>
Expand Down

0 comments on commit 11a8d31

Please sign in to comment.