Skip to content

Commit 07421de

Browse files
Enhance README with detailed extension usage
Clarified the functionality of the extension and updated the example configuration.
1 parent d496608 commit 07421de

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ This Sphinx extension converts GitHub alerts to Sphinx admonitions.
66

77
## What does it do?
88

9-
This extension allows you to use [GitHub alerts](https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax#alerts) within your Sphinx project.
9+
This extension allows you to use [GitHub alerts](https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax#alerts) within your Sphinx project. This is particulary useful if you're editing your sphinx / jupyterbook / teachbook in GitHub, making use of GitHub alerts and the markdown previewer of GitHub. Your Sphinx project will look similar to the preview in GitHub for these GitHub alerts.
1010

1111
Only top-level alerts are allowed and are convert to a top-level admonition in the language (`MD` or `rST`) of the source file. The source file does not change.
1212

@@ -51,7 +51,7 @@ sphinx:
5151
or in your `conf.py` file, add the extension to the `extensions` list and specify the location of your bib file:
5252

5353
```python
54-
extensions = [...,"sphinx_apa_references",...]
54+
extensions = [...,"sphinx_github_alerts",...]
5555
```
5656

5757
## Configuration

0 commit comments

Comments
 (0)