You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.rst
+9-7Lines changed: 9 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -24,7 +24,7 @@ Add the following to ``conf.py`` to enable the extension:
24
24
25
25
extensions = ["sphinx_notion"]
26
26
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:
28
28
29
29
.. code-block:: python
30
30
@@ -35,7 +35,7 @@ For collapsible sections (toggle blocks), also add the sphinx-toolbox collapse e
35
35
"sphinx_toolbox.collapse",
36
36
]
37
37
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:
39
39
40
40
.. code-block:: python
41
41
@@ -79,7 +79,7 @@ For TODO list support, also add the `sphinx-immaterial <https://github.com/jbms/
79
79
"sphinx_notion",
80
80
]
81
81
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:
83
83
84
84
.. code-block:: python
85
85
@@ -101,7 +101,7 @@ For rest-example blocks support, also add the `sphinx-toolbox <https://sphinx-to
101
101
"sphinx_notion",
102
102
]
103
103
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.
105
105
106
106
Supported markup
107
107
----------------
@@ -131,7 +131,8 @@ See a `sample document source <https://raw.githubusercontent.com/adamtheturtle/s
131
131
Using Audio
132
132
-----------
133
133
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:
135
136
136
137
.. code-block:: rst
137
138
@@ -141,10 +142,11 @@ Audio files can be embedded using the ``audio`` directive. Both remote URLs and
141
142
142
143
The audio will be rendered as an audio player in the generated Notion page.
143
144
144
-
Using PDF
145
+
Using PDFs
145
146
----------
146
147
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.
0 commit comments