fix: add footer_end to the documentation (#1285)

related to #1284
pydata · Apr 5, 2023 · a55cb93 · a55cb93
1 parent d98350b
commit a55cb93
Showing 1 changed file with 22 additions and 21 deletions.
diff --git a/docs/user_guide/layout.rst b/docs/user_guide/layout.rst
@@ -233,12 +233,12 @@ By default, the following configuration is used:
 .. code-block:: python
 
    html_theme_options = {
-   ...
+   # ...
    "navbar_start": ["navbar-logo"],
    "navbar_center": ["navbar-nav"],
    "navbar_end": ["navbar-icon-links"],
    "navbar_persistent": ["search-button"]
-   ...
+   # ...
    }
 
 .. warning::
@@ -254,9 +254,9 @@ page. This equals the following default configuration:
 .. code-block:: python
 
    html_theme_options = {
-      ...
+      # ...
       "navbar_align": "content"
-      ...
+      # ...
    }
 
 If instead you'd like these items to snap to the left (closer to the logo), use this
@@ -265,19 +265,19 @@ configuration:
 .. code-block:: python
 
    html_theme_options = {
-      ...
+      # ...
       "navbar_align": "left"
-      ...
+      # ...
    }
 
 If you'd like these items to snap to the right of the page, use this configuration:
 
 .. code-block:: python
 
    html_theme_options = {
-      ...
+      # ...
       "navbar_align": "right"
-      ...
+      # ...
    }
 
 
@@ -350,9 +350,9 @@ By default, it has the following templates:
 .. code-block:: python
 
     html_theme_options = {
-      ...
+      # ...
       "primary_sidebar_end": ["sidebar-ethical-ads"],
-      ...
+      # ...
     }
 
 Remove the primary sidebar from pages
@@ -410,9 +410,9 @@ By default, it has the following templates:
 .. code-block:: python
 
     html_theme_options = {
-      ...
+      # ...
       "secondary_sidebar_items": ["page-toc", "edit-this-page", "sourcelink"],
-      ...
+      # ...
     }
 
 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:
 .. code-block:: python
 
     html_theme_options = {
-      ...
+      # ...
       "article_footer_items": ["prev-next.html"],
-      ...
+      # ...
     }
 
 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
 .. code-block:: python
 
     html_theme_options = {
-      ...
+      # ...
       "content_footer_items": ["your-template.html"],
-      ...
+      # ...
     }
 
 .. _layout-footer:
@@ -479,9 +479,10 @@ By default, ``footer_end`` is empty, and ``footer_start`` has the following temp
 .. code-block:: python
 
     html_theme_options = {
-      ...
-      "footer_start": ["copyright", "sphinx-version", "theme-version"],
-      ...
+      #...
+      "footer_start": ["copyright", "sphinx-version"],
+      "footer_end": ["theme-version"]
+      #...
     }
 
 Within each subsection, components will stack **vertically**.
@@ -546,7 +547,7 @@ could do so with the following steps:
    .. code-block:: python
 
       html_theme_options = {
-      ...
+      # ...
       "navbar_start": ["navbar-logo", "version"],
-      ...
+      # ...
       }