Skip to content

Commit a55cb93

Browse files
authored
fix: add footer_end to the documentation (#1285)
related to #1284
1 parent d98350b commit a55cb93

File tree

1 file changed

+22
-21
lines changed

1 file changed

+22
-21
lines changed

docs/user_guide/layout.rst

Lines changed: 22 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -233,12 +233,12 @@ By default, the following configuration is used:
233233
.. code-block:: python
234234
235235
html_theme_options = {
236-
...
236+
# ...
237237
"navbar_start": ["navbar-logo"],
238238
"navbar_center": ["navbar-nav"],
239239
"navbar_end": ["navbar-icon-links"],
240240
"navbar_persistent": ["search-button"]
241-
...
241+
# ...
242242
}
243243
244244
.. warning::
@@ -254,9 +254,9 @@ page. This equals the following default configuration:
254254
.. code-block:: python
255255
256256
html_theme_options = {
257-
...
257+
# ...
258258
"navbar_align": "content"
259-
...
259+
# ...
260260
}
261261
262262
If instead you'd like these items to snap to the left (closer to the logo), use this
@@ -265,19 +265,19 @@ configuration:
265265
.. code-block:: python
266266
267267
html_theme_options = {
268-
...
268+
# ...
269269
"navbar_align": "left"
270-
...
270+
# ...
271271
}
272272
273273
If you'd like these items to snap to the right of the page, use this configuration:
274274

275275
.. code-block:: python
276276
277277
html_theme_options = {
278-
...
278+
# ...
279279
"navbar_align": "right"
280-
...
280+
# ...
281281
}
282282
283283
@@ -350,9 +350,9 @@ By default, it has the following templates:
350350
.. code-block:: python
351351
352352
html_theme_options = {
353-
...
353+
# ...
354354
"primary_sidebar_end": ["sidebar-ethical-ads"],
355-
...
355+
# ...
356356
}
357357
358358
Remove the primary sidebar from pages
@@ -410,9 +410,9 @@ By default, it has the following templates:
410410
.. code-block:: python
411411
412412
html_theme_options = {
413-
...
413+
# ...
414414
"secondary_sidebar_items": ["page-toc", "edit-this-page", "sourcelink"],
415-
...
415+
# ...
416416
}
417417
418418
To learn how to further customize or remove the secondary sidebar, please check :doc:`page-toc`.
@@ -430,9 +430,9 @@ By default, it has the following templates:
430430
.. code-block:: python
431431
432432
html_theme_options = {
433-
...
433+
# ...
434434
"article_footer_items": ["prev-next.html"],
435-
...
435+
# ...
436436
}
437437
438438
Hide the previous and next buttons
@@ -459,9 +459,9 @@ By default it is empty, but you can add templates to it with the following confi
459459
.. code-block:: python
460460
461461
html_theme_options = {
462-
...
462+
# ...
463463
"content_footer_items": ["your-template.html"],
464-
...
464+
# ...
465465
}
466466
467467
.. _layout-footer:
@@ -479,9 +479,10 @@ By default, ``footer_end`` is empty, and ``footer_start`` has the following temp
479479
.. code-block:: python
480480
481481
html_theme_options = {
482-
...
483-
"footer_start": ["copyright", "sphinx-version", "theme-version"],
484-
...
482+
#...
483+
"footer_start": ["copyright", "sphinx-version"],
484+
"footer_end": ["theme-version"]
485+
#...
485486
}
486487
487488
Within each subsection, components will stack **vertically**.
@@ -546,7 +547,7 @@ could do so with the following steps:
546547
.. code-block:: python
547548
548549
html_theme_options = {
549-
...
550+
# ...
550551
"navbar_start": ["navbar-logo", "version"],
551-
...
552+
# ...
552553
}

0 commit comments

Comments
 (0)