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: docs/user_guide/theme-elements.md
+13-14Lines changed: 13 additions & 14 deletions
Original file line number
Diff line number
Diff line change
@@ -135,24 +135,13 @@ I was made with the `{admonition}` directive and a `sidebar` class.
135
135
I was made with the `{sidebar}` directive.
136
136
```
137
137
138
-
## Footnotes
139
-
140
-
Here's one footnote[^1] and another footnote [^2] and a named footenote[^named], symbol [^*].
141
-
142
-
[^1]: Foo bar foo bar. Foo bar foo bar. Foo bar foo bar. Foo bar foo bar. Foo bar foo bar. Foo bar foo bar. Foo bar foo bar. Foo bar foo bar. Foo bar foo bar. Foo bar foo bar. Foo bar foo bar. Foo bar foo bar.
143
-
[^2]: Foo bar foo bar. Foo bar foo bar. Foo bar foo bar. Foo bar foo bar. Foo bar foo bar. Foo bar foo bar. Foo bar foo bar. Foo bar foo bar. Foo bar foo bar. Foo bar foo bar. Foo bar foo bar. Foo bar foo bar.
144
-
[^named]: Foo bar foo bar. Foo bar foo bar. Foo bar foo bar. Foo bar foo bar. Foo bar foo bar. Foo bar foo bar. Foo bar foo bar. Foo bar foo bar. Foo bar foo bar. Foo bar foo bar. Foo bar foo bar. Foo bar foo bar.
145
-
[^*]: Foo bar foo bar. Foo bar foo bar. Foo bar foo bar. Foo bar foo bar. Foo bar foo bar. Foo bar foo bar. Foo bar foo bar. Foo bar foo bar. Foo bar foo bar. Foo bar foo bar. Foo bar foo bar. Foo bar foo bar.
146
-
147
-
## Version changes
148
-
149
138
This theme supports a shorthand way of making **admonitions behave like sidebars**.
150
-
This can be a helpful way of highlighting content that lives to the side of your main text without interrupting the vertical flow as much.
139
+
This can be a helpful way of highlighting content without interrupting the vertical flow as much.
151
140
152
-
For example, look to the right of an "admonition sidebar" and a traditional Sphinx sidebar.
141
+
For example, on the right are an "admonition sidebar" and a traditional Sphinx sidebar.
153
142
154
143
To make an admonition behave like a sidebar, add the `sidebar` class to its list of classes.
155
-
For example, the admonition sidebar was created with the following Markdown:
144
+
The admonition sidebar in this section was created with the following Markdown:
156
145
157
146
````md
158
147
```{admonition} A sidebar admonition!
@@ -161,6 +150,16 @@ Some sidebar content.
161
150
```
162
151
````
163
152
153
+
## Footnotes
154
+
155
+
Here's a numeric footnote[^1], another one (preceded by a space) [^2], a named footnote[^named], and a symbolic one[^*].
156
+
All will end up as numbers in the rendered HTML, but in the source they look like `[^1]`, `[^2]`, `[^named]` and `[^*]`.
157
+
158
+
[^1]: Foo bar foo bar. Foo bar foo bar. Foo bar foo bar. Foo bar foo bar. Foo bar foo bar. Foo bar foo bar. Foo bar foo bar. Foo bar foo bar. Foo bar foo bar. Foo bar foo bar. Foo bar foo bar. Foo bar foo bar.
159
+
[^2]: Foo bar foo bar. Foo bar foo bar. Foo bar foo bar. Foo bar foo bar. Foo bar foo bar. Foo bar foo bar. Foo bar foo bar. Foo bar foo bar. Foo bar foo bar. Foo bar foo bar. Foo bar foo bar. Foo bar foo bar.
160
+
[^named]: Foo bar foo bar. Foo bar foo bar. Foo bar foo bar. Foo bar foo bar. Foo bar foo bar. Foo bar foo bar. Foo bar foo bar. Foo bar foo bar. Foo bar foo bar. Foo bar foo bar. Foo bar foo bar. Foo bar foo bar.
161
+
[^*]: Foo bar foo bar. Foo bar foo bar. Foo bar foo bar. Foo bar foo bar. Foo bar foo bar. Foo bar foo bar. Foo bar foo bar. Foo bar foo bar. Foo bar foo bar. Foo bar foo bar. Foo bar foo bar. Foo bar foo bar.
162
+
164
163
## Link shortening for git repository services
165
164
166
165
Many projects have links back to their issues / PRs hosted on platforms like **GitHub** or **GitLab**.
0 commit comments