Added troubleshooting section to the Usage Guide.

lucaslrodri · Oct 10, 2024 · 6594103 · 6594103
1 parent d71bc66
commit 6594103
Show file tree

Hide file tree

Showing 8 changed files with 285 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -241,6 +241,12 @@ Contributions are welcome from everyone! Whether you're reporting bugs, submitti
 
 All notable changes to this project are presented below.
 
+## v0.5.6
+
+**✨ Improvements**
+
+- Docs: Added troubleshooting section to the Usage Guide.
+
 ## v0.5.5
 
 **🐞 Bug Fixes**

diff --git a/docs/about/changelog.md b/docs/about/changelog.md
@@ -1,5 +1,11 @@
 All notable changes to this project are presented below.
 
+## v0.5.6
+
+**✨ Improvements**
+
+- Docs: Added troubleshooting section to the Usage Guide.
+
 ## v0.5.5
 
 **🐞 Bug Fixes**

diff --git a/docs/usage/troubleshooting.md b/docs/usage/troubleshooting.md
@@ -0,0 +1,32 @@
+## Troubleshooting pdflatex PATH Issues
+
+If you encounter issues with the `pdflatex` PATH and receive the following error message:
+
+<div class="result" style="padding-right: 0;">
+<div class="log-output">
+/bin/sh: 1: pdflatex: not found
+</div>
+</div>
+
+First, ensure that the `pdflatex` command is accessible in your IDE environment. In some cases, you may need to add `pdflatex` to your system's PATH, or specify the `~` symbol before the command.
+
+If you continue to experience issues, you can use the `-tp=<tex_program>` option to specify a custom `pdflatex` PATH. Here's an example:
+
+```python
+# Replace it for the path 
+PDF_LATEX_PATH = r"C:\Users\lucas\AppData\Local\Programs\MiKTeX\miktex\bin\x64\pdflatex.exe"
+```
+
+```latex
+%%tikz -as=tikz -t=pgfplots -nt -tp="$PDF_LATEX_PATH"
+\begin{axis}[
+  xlabel=$x$,
+  ylabel={$f(x) = x^2 - x + 4$}
+]
+\addplot {x^2 - x + 4};
+\end{axis}
+```
+
+<div class="result" markdown>
+![Another quadratic formula](../assets/tikz/another_quadratic.svg)
+</div>
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -31,6 +31,7 @@ nav:
   - Usage guide: 
     - Usage as IPython Magics: usage/as-magic.md
     - Usage as a Python package: usage/as-package.md
+    - Troubleshooting: usage/troubleshooting.md
   - Additional options: arguments.md
   - API reference: api.md
   - About:

diff --git a/notebooks/GettingStarted.ipynb b/notebooks/GettingStarted.ipynb
diff --git a/notebooks/outputs/a_dot.pdf b/notebooks/outputs/a_dot.pdf
diff --git a/notebooks/outputs/angle.pdf b/notebooks/outputs/angle.pdf
diff --git a/pyproject.toml b/pyproject.toml
@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "jupyter-tikz"
-version = "0.5.5"
+version = "0.5.6"
 description = "IPython Magics for rendering TeX/TikZ in Jupyter Notebooks"
 license = "MIT"
 authors = ["lucaslrodri"]