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.

.. _Sphinx: http://www.sphinx-doc.org
.. _Read the Docs: http://www.readthedocs.org

使用此主题
----------------

:doc:`安装`
    如何在您的 Sphinx 项目上安装此主题。

:doc:`配置`
    主题配置和自定义选项。

:ref:`supported-browsers`
    支持的浏览器/操作系统组合。

:ref:`supported-dependencies`
    支持项目依赖项，如 Python 和 Sphinx。

发展
-----------

:doc:`贡献`
    如何对主题做出改变。

:doc:`Development guidelines <development>`
    主题开发人员用于开发和测试更改的指南。

`Read the Docs contributor guide`_
    我们的贡献指南适用于由 Read the Docs 核心团队维护的所有项目。

:doc:`变更日志`
    主题开发更新日志。

:doc:`Demo documentation <demo/structure>`
    主题的样式指南测试环境，在此测试新的变化。


.. _Read the Docs contributor guide: https://docs.readthedocs.io/en/stable/contribute.html


.. Hidden TOCs

.. toctree::
   :caption: 主题文档
   :maxdepth: 2
   :hidden:

   安装
   配置
   发展
   贡献

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

   变更日志

.. toctree::
    :maxdepth: 2
    :numbered:
    :caption: 演示文档
    :hidden:

    demo/结构元素
    demo/段落级标记
    demo/列表和表格
    demo/api

.. toctree::
    :maxdepth: 3
    :numbered:
    :caption: 这是一个很长的菜单的超长标题
    :hidden:

    demo/长置顶导航
    
.. toctree::
    :maxdepth: 3
    :caption: 面包屑

    demo/level1/index.rst