From fb0b398a7ff9c89fdeff1820a2cc0c6a4e34594c Mon Sep 17 00:00:00 2001
From: "Mayr, Hannes" <hannes.mayr@stud.tu-darmstadt.de>
Date: Tue, 10 Jan 2023 15:10:02 +0100
Subject: [PATCH] Add documentation for finding installed fonts on the system.
---
docs/source/customization.rst | 19 +++++++++++++++++++
docs/source/index.rst | 1 +
2 files changed, 20 insertions(+)
create mode 100644 docs/source/customization.rst
diff --git a/docs/source/customization.rst b/docs/source/customization.rst
new file mode 100644
index 0000000..c599f24
--- /dev/null
+++ b/docs/source/customization.rst
@@ -0,0 +1,19 @@
+Customization of plotID
+=======================
+How your plot will be tagged by plotID is highly customizable. Please have a look in the documentation of the function "tagplot" to get an overview of all available keyword arguments.
+
+To use a custom font for the ID on your plot, it is necessary to specify the absolute path to the ".otf" or ".ttf" file. You can put the file in your working directory and give the path to it from the script where you run plotID in. Or you can use system wide installed fonts. To make it easier for you to find already installed fonts in your system, we list here common locations for font files:
+
+Linux:
+
+- /usr/share/fonts
+- /usr/local/share/fonts
+- ~/.fonts
+
+Windows:
+
+- C:\\Windows\\Fonts
+
+MacOS:
+
+- /Library/Fonts/
\ No newline at end of file
diff --git a/docs/source/index.rst b/docs/source/index.rst
index ec95047..51a7a84 100644
--- a/docs/source/index.rst
+++ b/docs/source/index.rst
@@ -12,6 +12,7 @@ Welcome to plotID's documentation!
Overview <readme_link.rst>
Installation <installation.rst>
+ Customization <customization.rst>
Dependencies <dependencies.rst>
Structure and architecture <structure.rst>
About <about.rst>
--
GitLab