Sphinx-tabs extension Tabbed views for Sphinx

See also

sphinx-tabs Build Status

Create tabbed content in Sphinx documentation when building HTML.

For example, see the [Raw] code of example/index.rst which generates the following:

A live demo can be found here: https://djungelorm.github.io/sphinx-tabs/

Installation

pip install sphinx-tabs

To enable the extension in Sphinx, add the following to your conf.py:

extensions = ['sphinx_tabs.tabs']

If you are using Read The Docs for building your documentation, the extension must be added as a requirement. Please add the following to requirements.txt at the root of the project:

https://github.com/djungelorm/sphinx-tabs/releases/download/v1.1.12/sphinx-tabs-1.1.13.tar.gz

An example of this can be found here.

Basic Tabs

Basic tabs can be coded as follows:

.. tabs::

   .. tab:: Apples

      Apples are green, or sometimes red.

   .. tab:: Pears

      Pears are green.

   .. tab:: Oranges

      Oranges are orange.

Apples

Pears

Oranges

Apples are green, or sometimes red.

Pears are green.

Oranges are orange.

Grouped Tabs

Tabs can be grouped, so that changing the current tab in one area changes the current tab in the another area. For example:

.. tabs::

   .. group-tab:: Linux

      Linux Line 1

   .. group-tab:: Mac OSX

      Mac OSX Line 1

   .. group-tab:: Windows

      Windows Line 1

.. tabs::

   .. group-tab:: Linux

      Linux Line 2

   .. group-tab:: Mac OSX

      Mac OSX Line 2

   .. group-tab:: Windows

      Windows Line 2

Test

Linux

Mac OSX

Windows

Linux Line 1

Mac OSX Line 1

Windows Line 1

Linux

Mac OSX

Windows

Linux Line 2

Mac OSX Line 2

Windows Line 2

Code Tabs

Tabs containing code areas with syntax highlighting can be created as follows:

.. tabs::

   .. code-tab:: c

         int main(const int argc, const char **argv) {
           return 0;
         }

   .. code-tab:: c++

         int main(const int argc, const char **argv) {
           return 0;
         }

   .. code-tab:: py

         def main():
             return

   .. code-tab:: java

         class Main {
             public static void main(String[] args) {
             }
         }

   .. code-tab:: julia

         function main()
         end

   .. code-tab:: fortran

         PROGRAM main
         END PROGRAM main

Test

C

C++

Python

Java

Julia

Fortran

int main(const int argc, const char **argv) {
  return 0;
}

int main(const int argc, const char **argv) {
  return 0;
}

def main():
    return

class Main {
    public static void main(String[] args) {
    }
}

function main()
end

PROGRAM main
END PROGRAM main