Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

fix: add footer_end to the documentation #1285

Merged
merged 1 commit into from Apr 5, 2023
Merged

fix: add footer_end to the documentation #1285

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
43 changes: 22 additions & 21 deletions docs/user_guide/layout.rst
View file
Open in desktop
Expand Up @@ -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::
Expand All @@ -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
Expand All @@ -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"
...
# ...
}


Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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`.
Expand All @@ -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
Expand All @@ -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:
Expand All @@ -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**.
Expand Down Expand Up @@ -546,7 +547,7 @@ could do so with the following steps:
.. code-block:: python

html_theme_options = {
...
# ...
"navbar_start": ["navbar-logo", "version"],
...
# ...
}