|
1 | | -.. include:: ../README.rst |
| 1 | +Read the Docs Sphinx Theme |
| 2 | +========================== |
| 3 | + |
| 4 | +This Sphinx_ theme was designed to provide a great reader experience for |
| 5 | +documentation users on both desktop and mobile devices. This theme is commonly |
| 6 | +used with projects on `Read the Docs`_ but can work with any Sphinx project. |
| 7 | + |
| 8 | +.. _Sphinx: http://www.sphinx-doc.org |
| 9 | +.. _Read the Docs: http://www.readthedocs.org |
| 10 | + |
| 11 | +Using this theme |
| 12 | +---------------- |
| 13 | + |
| 14 | +:doc:`installing` |
| 15 | + How to install this theme on your Sphinx project. |
| 16 | + |
| 17 | +:doc:`configuring` |
| 18 | + Theme configuration and customization options. |
| 19 | + |
| 20 | +:ref:`supported-browsers` |
| 21 | + Supported browser/operating system combinations. |
| 22 | + |
| 23 | +:ref:`supported-dependencies` |
| 24 | + Supported project dependencies, like Python and Sphinx. |
| 25 | + |
| 26 | +Development |
| 27 | +----------- |
| 28 | + |
| 29 | +:doc:`contributing` |
| 30 | + How to contribute changes to the theme. |
| 31 | + |
| 32 | +:doc:`Development guidelines <development>` |
| 33 | + Guidelines the theme developers use for developing and testing changes. |
| 34 | + |
| 35 | +`Read the Docs contributor guide`_ |
| 36 | + Our contribution guidelines extend to all projects maintained by Read the |
| 37 | + Docs core team. |
| 38 | + |
| 39 | +:doc:`changelog` |
| 40 | + The theme development changelog. |
| 41 | + |
| 42 | +:doc:`Demo documentation <demo/structure>` |
| 43 | + The theme's styleguide test environment, where new changes are tested. |
| 44 | + |
| 45 | + |
| 46 | +.. _Read the Docs contributor guide: https://docs.readthedocs.io/en/stable/contribute.html |
| 47 | + |
| 48 | + |
| 49 | +.. Hidden TOCs |
2 | 50 |
|
3 | 51 | .. toctree:: |
4 | 52 | :caption: Theme Documentation |
5 | 53 | :maxdepth: 2 |
| 54 | + :hidden: |
6 | 55 |
|
7 | 56 | installing |
8 | 57 | configuring |
|
19 | 68 | :maxdepth: 2 |
20 | 69 | :numbered: |
21 | 70 | :caption: Demo Documentation |
| 71 | + :hidden: |
22 | 72 |
|
23 | 73 | demo/structure |
24 | 74 | demo/demo |
|
29 | 79 | :maxdepth: 3 |
30 | 80 | :numbered: |
31 | 81 | :caption: This is an incredibly long caption for a long menu |
| 82 | + :hidden: |
32 | 83 |
|
33 | 84 | demo/long |
0 commit comments