Skip to content

Commit dfa275d

Browse files
committed
Fix Sphinx markdown builder warnings for admonitions
Replace MyST-Parser admonition syntax (:::{tip} and :::{admonition}) with plain markdown formatting using bold text prefixes. The sphinx_markdown_builder doesn't fully support these node types.
1 parent 5d237ce commit dfa275d

File tree

3 files changed

+3
-8
lines changed

3 files changed

+3
-8
lines changed

README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -184,6 +184,7 @@ See also [the llm tag](https://simonwillison.net/tags/llm/) on my blog.
184184
* [Extra HTTP headers](https://llm.datasette.io/en/stable/other-models.html#extra-http-headers)
185185
* [Tools](https://llm.datasette.io/en/stable/tools.html)
186186
* [How tools work](https://llm.datasette.io/en/stable/tools.html#how-tools-work)
187+
* [Warning: Tools can be dangerous](https://llm.datasette.io/en/stable/tools.html#warning-tools-can-be-dangerous)
187188
* [Trying out tools](https://llm.datasette.io/en/stable/tools.html#trying-out-tools)
188189
* [LLM’s implementation of tools](https://llm.datasette.io/en/stable/tools.html#llm-s-implementation-of-tools)
189190
* [Default tools](https://llm.datasette.io/en/stable/tools.html#default-tools)

docs/templates.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -112,13 +112,11 @@ llm templates edit summarize
112112
```
113113
This will open the system default editor.
114114

115-
:::{tip}
116-
You can control which editor will be used here using the `EDITOR` environment variable - for example, to use VS Code:
115+
**Tip:** You can control which editor will be used here using the `EDITOR` environment variable - for example, to use VS Code:
117116
```bash
118117
export EDITOR="code -w"
119118
```
120119
Add that to your `~/.zshrc` or `~/.bashrc` file depending on which shell you use (`zsh` is the default on macOS since macOS Catalina in 2019).
121-
:::
122120

123121
You can create or edit template files directly in the templates directory. The location of this directory is shown by the `llm templates path` command:
124122
```bash

docs/tools.md

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -20,14 +20,11 @@ A tool is effectively a function that the model can request to be executed. Here
2020

2121
This sequence can run several times in a loop, allowing the LLM to access data, act on that data and then pass that data off to other tools for further processing.
2222

23-
:::{admonition} Tools can be dangerous
24-
:class: danger
25-
2623
(tools-warning)=
2724

2825
## Warning: Tools can be dangerous
2926

30-
Applications built on top of LLMs suffer from a class of attacks called [prompt injection](https://simonwillison.net/tags/prompt-injection/) attacks. These occur when a malicious third party injects content into the LLM which causes it to take tool-based actions that act against the interests of the user of that application.
27+
**Danger:** Applications built on top of LLMs suffer from a class of attacks called [prompt injection](https://simonwillison.net/tags/prompt-injection/) attacks. These occur when a malicious third party injects content into the LLM which causes it to take tool-based actions that act against the interests of the user of that application.
3128

3229
Be very careful about which tools you enable when you potentially might be exposed to untrusted sources of content - web pages, GitHub issues posted by other people, email and messages that have been sent to you that could come from an attacker.
3330

@@ -38,7 +35,6 @@ Watch out for [the lethal trifecta](https://simonwillison.net/2025/Jun/16/the-le
3835
- the ability to exfiltrate information
3936

4037
Anyone who can feed malicious instructions into your LLM - by leaving them on a web page it visits, or sending an email to an inbox that it monitors - could be able to trick your LLM into using other tools to access your private information and then exfiltrate (pass out) that data to somewhere the attacker can see it.
41-
:::
4238

4339
(tools-trying-out)=
4440

0 commit comments

Comments
 (0)