index.rst

Read the Docs Sphinx Theme

This Sphinx theme was designed to provide a great reader experience for documentation users on both desktop and mobile devices. This theme is commonly used with projects on Read the Docs but can work with any Sphinx project.

Using this theme

:doc:`installing`

How to install this theme on your Sphinx project.

:doc:`configuring`

Theme configuration and customization options.

:ref:`supported-browsers`

Supported browser/operating system combinations.

:ref:`supported-dependencies`

Supported project dependencies, like Python and Sphinx.

Development

:doc:`contributing`

How to contribute changes to the theme.

:doc:`Development guidelines <development>`

Guidelines the theme developers use for developing and testing changes.

Read the Docs contributor guide

Our contribution guidelines extend to all projects maintained by Read the Docs core team.

:doc:`changelog`

The theme development changelog.

:doc:`Demo documentation <demo/structure>`

The theme's styleguide test environment, where new changes are tested.

.. toctree::
   :caption: Theme Documentation
   :maxdepth: 2
   :hidden:

   installing
   configuring
   development
   contributing

.. toctree::
   :maxdepth: 1
   :hidden:

   changelog

.. toctree::
    :maxdepth: 2
    :numbered:
    :caption: Demo Documentation
    :hidden:

    demo/structure
    demo/demo
    demo/lists_tables
    demo/api

.. toctree::
    :maxdepth: 3
    :numbered:
    :caption: This is an incredibly long caption for a long menu
    :hidden:

    demo/long

.. toctree::
    :maxdepth: 3
    :caption: Breadcrumbs

    demo/level1/index.rst