Skip to content

Commit 0dfdba8

Browse files
authored
📚 DOCS: mention sphinx_tabs_valid_builders in README (#56)
1 parent 9c228e6 commit 0dfdba8

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

‎README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,12 @@ To enable the extension in Sphinx, add the following to your conf.py:
2424
extensions = ['sphinx_tabs.tabs']
2525
```
2626

27+
If needed, there is a configuration option to allow additional builders to be considered compatible. For example, to add the `linkcheck` builder, add the following to your conf.py:
28+
29+
```python
30+
sphinx_tabs_valid_builders = ['linkcheck']
31+
```
32+
2733
If you are using [Read The Docs](https://readthedocs.org/) for building your documentation, the extension must be added as a requirement. Please add the following to `requirements.txt` at the root of the project:
2834

2935
```

0 commit comments

Comments
 (0)