Contents Menu Expand Light mode Dark mode Auto light/dark mode
sphinx-basic-ng
sphinx-basic-ng
  • Goals
  • Expectations

Usage

  • Getting Started
  • Skeleton
  • Components
    • Breadcrumbs
    • “Edit this page” link
    • Ethical Ads
    • Site Logo
    • Related Pages
    • “Hide search matches” link
    • Search input
    • Sidebar Drawer Toggles
    • “View this page” link
  • Glossary

Project

  • Development
  • Design
  • Changelog
  • License
  • GitHub
Back to top

Related Pages#

Sphinx provides “next page” and “previous page” information, when rendering a page. This information is useful for documentation which has some sort of flow, as well as providing more navigational capabilities to the reader.

Usage#

{% include "components/related-pages.html" with context %}

This will add a single div.related-pages, which may be empty if the relevant information is not available in the html-context.

The structure of this component is:

  • div.related-pages

    • a[href].next-page (omitted if there’s no next page)

      • div.page-info

        • div.context

          • span

            • “Next” with translation

        • div.title

          • Title of the page

    • a[href].prev-page (omitted if there’s no previous page)

      • div.page-info

        • div.context

          • span

            • “Previous” with translation

        • div.title

          • Title of the page

Configurability#

None.

Derivative themes may want to expose their own mechanism that allows hiding this component for documentation authors that don’t want to provide this to the reader.

Next
“Hide search matches” link
Previous
Site Logo
Copyright © 2023, Pradyun Gedam
Made with Sphinx and @pradyunsg's Furo
On this page
  • Related Pages
    • Usage
    • Configurability