Skip to content

Commit

Permalink
Describe configuration variables.
Browse files Browse the repository at this point in the history
  • Loading branch information
whitequark committed Apr 5, 2024
1 parent d5248d5 commit 9ddbb64
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,18 @@ This extension provides only one directive, `wavedrom`. Its argument is the base
Additional examples are available [in the test suite](/test/index.rst), as well as the corresponding [rendered output](https://yowasp.github.io/sphinxcontrib-wavedrom/).


Configuration
-------------

The extension recognizes these configuration variables in `conf.py`:

```py
# Default skin for waveforms. If `json["config"]["skin"]` is not set in the directive, it defaults
# to the value of this variable. Does not affect bit fields or circuits.
yowasp_wavedrom_skin = "default"
```


License
-------

Expand Down

0 comments on commit 9ddbb64

Please sign in to comment.