Skip to content
This repository was archived by the owner on Mar 13, 2024. It is now read-only.

Commit 83243b7

Browse files
niamhdougancoretl
authored andcommitted
Added article for embedding excalidraw diagrams and fixed config assertion tests
1 parent d8e794f commit 83243b7

File tree

4 files changed

+37
-2
lines changed

4 files changed

+37
-2
lines changed

docs/how-to.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,3 +10,4 @@ Practical step-by-step guides for the more experienced user.
1010

1111
how-to/existing
1212
how-to/update
13+
how-to/excalidraw

docs/how-to/excalidraw.rst

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
How to embed Excalidraw diagrams
2+
================================
3+
4+
Start off by creating your diagram in https://excalidraw.com
5+
6+
.. raw:: html
7+
:file: ../images/excalidraw-example.svg
8+
9+
Click 'Save as image' and make sure the 'Embed scene' checkbox is enabled. This is required for loading your image back into Excalidraw should you wish to make changes later on. Name your file and export to SVG, saving it inside ``docs/images``.
10+
11+
Add the following to embed it inside your documentation::
12+
13+
.. raw:: html
14+
:file: ../images/my-diagram.excalidraw.svg
15+
16+
It is preferred to use the above convention over ``.. image::`` in order to retain the font used by Excalidraw.
17+
18+
Rebuild the docs and open the resulting html inside a browser.

docs/images/excalidraw-example.svg

Lines changed: 16 additions & 0 deletions
Loading

tests/test_dls_python3_skeleton.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -41,8 +41,8 @@ def test_new_module(tmp_path: Path):
4141

4242
conf = ConfigParser()
4343
conf.read(module / "setup.cfg")
44-
assert conf["metadata"]["author"] == "Firstname Lastname"
45-
assert conf["metadata"]["author_email"] == "[email protected]"
44+
assert conf["metadata"]["author"] == '"Firstname Lastname"'
45+
assert conf["metadata"]["author_email"] == '"[email protected]"'
4646
versiongit_lines = [
4747
line
4848
for line in (module / "docs" / "reference" / "api.rst").read_text().splitlines()

0 commit comments

Comments
 (0)