Skip to content

Commit 096778f

Browse files
committed
Link to a bunch of extensions in the README
1 parent ffee172 commit 096778f

File tree

1 file changed

+9
-7
lines changed

1 file changed

+9
-7
lines changed

README.rst

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ Add the following to ``conf.py`` to enable the extension:
2424
2525
extensions = ["sphinx_notion"]
2626
27-
For collapsible sections (toggle blocks), also add the sphinx-toolbox collapse extension:
27+
For collapsible sections (toggle blocks), also add the `sphinx-toolbox collapse <https://sphinx-toolbox.readthedocs.io/en/stable/extensions/collapse.html>`_ extension:
2828

2929
.. code-block:: python
3030
@@ -35,7 +35,7 @@ For collapsible sections (toggle blocks), also add the sphinx-toolbox collapse e
3535
"sphinx_toolbox.collapse",
3636
]
3737
38-
For video support, also add the sphinxcontrib-video extension:
38+
For video support, also add the `sphinxcontrib-video <https://sphinxcontrib-video.readthedocs.io>`_ extension:
3939

4040
.. code-block:: python
4141
@@ -79,7 +79,7 @@ For TODO list support, also add the `sphinx-immaterial <https://github.com/jbms/
7979
"sphinx_notion",
8080
]
8181
82-
For mathematical equation support, also add the ``sphinx.ext.mathjax`` extension:
82+
For mathematical equation support, also add the `sphinx.ext.mathjax <https://www.sphinx-doc.org/en/master/usage/extensions/math.html#module-sphinx.ext.mathjax>`_ extension:
8383

8484
.. code-block:: python
8585
@@ -101,7 +101,7 @@ For rest-example blocks support, also add the `sphinx-toolbox <https://sphinx-to
101101
"sphinx_notion",
102102
]
103103
104-
PDF support is included by default with the sphinx-notionbuilder extension.
104+
PDF support is included by default with the ``sphinx-notionbuilder`` extension and builds on the `sphinx-simplepdf <https://sphinx-simplepdf.readthedocs.io/>`_ extension.
105105

106106
Supported markup
107107
----------------
@@ -131,7 +131,8 @@ See a `sample document source <https://raw.githubusercontent.com/adamtheturtle/s
131131
Using Audio
132132
-----------
133133

134-
Audio files can be embedded using the ``audio`` directive. Both remote URLs and local file paths are supported:
134+
Audio files can be embedded using the ``audio`` directive.
135+
Both remote URLs and local file paths are supported:
135136

136137
.. code-block:: rst
137138
@@ -141,10 +142,11 @@ Audio files can be embedded using the ``audio`` directive. Both remote URLs and
141142
142143
The audio will be rendered as an audio player in the generated Notion page.
143144

144-
Using PDF
145+
Using PDFs
145146
----------
146147

147-
PDF files can be embedded using the ``pdf-include`` directive. Both remote URLs and local file paths are supported.
148+
PDF files can be embedded using the ``pdf-include`` directive.
149+
Both remote URLs and local file paths are supported.
148150

149151
.. code-block:: rst
150152

0 commit comments

Comments
 (0)