Skip to content

Commit

Permalink
Update README to match actual behavior.
Browse files Browse the repository at this point in the history
The behavior was changed in commit 078551f.
  • Loading branch information
whitequark committed Apr 7, 2024
1 parent 202fddc commit a56b58d
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ WaveJSON diagram descriptions are always converted into SVG files; only the HTML
Usage
-----

This extension provides only one directive, `wavedrom`. Its argument is the base name, without extension, of the generated image file (in `<output directory>/_images/`; which must be unique in the entire document tree), and its contents is the raw WaveJSON file that can be copied to or from the editor. For example:
This extension provides only one directive, `wavedrom`. Its argument is the base name, without extension, of the generated image file (in `<output directory>/<document directory>/_images/`; which must be unique for that document directory), and its contents is the raw WaveJSON file that can be copied to or from the editor. For example:

```rst
.. wavedrom:: clk_and_data
Expand Down

0 comments on commit a56b58d

Please sign in to comment.