1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
|
# Sphinx extension styles
This page shows of some special-case styling for various Sphinx extensions.
## `sphinxcontrib-bibtex` - References and bibliographies
[`sphinxcontrib-bibtex`](https://sphinxcontrib-bibtex.readthedocs.io/en/latest/) provides support for citations and bibliographies.
Because this theme deals with scholarly and scientific communication, `sphinxcontrib-bibtex` should work particularly well.
Here's are a few citations:
- Default citation {cite}`project_jupyter-proc-scipy-2018`, {cite}`holdgraf_rapid_2016,project_jupyter-proc-scipy-2018`. (should be same as parenthetical)
- Parenthetical citation {cite:p}`project_jupyter-proc-scipy-2018`, {cite:p}`holdgraf_rapid_2016,project_jupyter-proc-scipy-2018`.
- Textual citation {cite:t}`project_jupyter-proc-scipy-2018`, {cite:t}`holdgraf_rapid_2016,project_jupyter-proc-scipy-2018`.
And here's a bibliography:
```{bibliography}
```
## `ABlog` - Blog post list
[ABlog](https://ablog.readthedocs.io/) is a Sphinx extension for blogging with Sphinx.
Here's a sample post list:
```{postlist}
:date: "%Y-%m-%d"
:format: "{date} - {title}"
:excerpts:
```
## `sphinx-togglebutton` - Toggle content with buttons
A block toggle:
```{toggle}
:::{note} This note is toggled!
:::
```
A block toggle in the margin:
::::{container} margin
```{toggle}
:::{note} This note is toggled!
:::
```
::::
An admonition toggle:
:::{note}
:class: dropdown
This note will be toggled!
:::
An admonition toggle in the margin
::::{note}
:class: margin
:::{toggle}
This toggle is in the margin!
:::
::::
## `sphinx-tabs` - Tabbed content
% For some reason sphinx-tabs doesn't work properly with myst markdown
% so using rST here.
````{eval-rst}
.. tabs::
.. tab:: Apples
Apples are green, or sometimes red.
.. tab:: Pears
Pears are green.
.. tab:: Oranges
Oranges are orange.
````
## `sphinxcontrib.youtube` for videos
[`sphinxcontrib.youtube`](https://github.com/sphinx-contrib/youtube) makes it possible to easily embed videos in your documentation.
```{youtube} 2Z7wDaYt53Y
```
## `sphinx-design` for UI components
{bdg-primary}`Test badge`.
|
