IntenseWebs/sphinx
3
0
Fork 0
mirror of https://github.com/sphinx-doc/sphinx.git synced 2025-02-25 18:55:22 -06:00
Code Issues Packages Projects Releases Wiki Activity

fix document: rtd is optional from 1.4

Browse Source
This commit is contained in:
Yoshiki Shibukawa 2016-08-23 18:42:12 +09:00
parent 8e777063fd
commit dd09457d7e
1 changed files with 35 additions and 22 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

57
doc/theming.rst
View File

@ -86,33 +86,28 @@ Builtin themes
+--------------------+--------------------+ +--------------------+--------------------+
| **Theme overview** | | | **Theme overview** | |
+--------------------+--------------------+ +--------------------+--------------------+
| |alabaster| | |sphinx_rtd_theme| | | |alabaster| | |classic| |
| | | | | |
| *alabaster* | *sphinx_rtd_theme* | | *alabaster* | *classic* |
+--------------------+--------------------+ +--------------------+--------------------+
| |classic| | |sphinxdoc| | | |sphinxdoc| | |scrolls| |
| | | | | |
| *classic* | *sphinxdoc* | | *sphinxdoc* | *scrolls* |
+--------------------+--------------------+ +--------------------+--------------------+
| |scrolls| | |agogo| | | |agogo| | |traditional| |
| | | | | |
| *scrolls* | *agogo* | | *agogo* | *traditional* |
+--------------------+--------------------+ +--------------------+--------------------+
| |traditional| | |nature| | | |nature| | |haiku| |
| | | | | |
| *traditional* | *nature* | | *nature* | *haiku* |
+--------------------+--------------------+ +--------------------+--------------------+
| |haiku| | |pyramid| | | |pyramid| | |bizstyle| |
| | | | | |
| *haiku* | *pyramid* | | *pyramid* | *bizstyle* |
+--------------------+--------------------+
| |bizstyle| | |
| | |
| *bizstyle* | |
+--------------------+--------------------+ +--------------------+--------------------+
.. |alabaster| image:: themes/alabaster.png .. |alabaster| image:: themes/alabaster.png
.. |sphinx_rtd_theme| image:: themes/sphinx_rtd_theme.png
.. |classic| image:: themes/classic.png .. |classic| image:: themes/classic.png
.. |sphinxdoc| image:: themes/sphinxdoc.png .. |sphinxdoc| image:: themes/sphinxdoc.png
.. |scrolls| image:: themes/scrolls.png .. |scrolls| image:: themes/scrolls.png
@ -147,13 +142,6 @@ These themes are:
.. _Alabaster theme: https://pypi.python.org/pypi/alabaster .. _Alabaster theme: https://pypi.python.org/pypi/alabaster
* **sphinx_rtd_theme** -- `Read the Docs Sphinx Theme`_.
This is a mobile-friendly sphinx theme that was made for readthedocs.org.
View a working demo over on readthedocs.org. You can get options information
at `Read the Docs Sphinx Theme`_ page.
.. _Read the Docs Sphinx Theme: https://pypi.python.org/pypi/sphinx_rtd_theme
* **classic** -- This is the classic theme, which looks like `the Python 2 * **classic** -- This is the classic theme, which looks like `the Python 2
documentation <https://docs.python.org/2/>`_. It can be customized via documentation <https://docs.python.org/2/>`_. It can be customized via
these options: these options:
@ -359,3 +347,28 @@ is built with the classic theme, the output directory will contain a
.. [1] It is not an executable Python file, as opposed to :file:`conf.py`, .. [1] It is not an executable Python file, as opposed to :file:`conf.py`,
because that would pose an unnecessary security risk if themes are because that would pose an unnecessary security risk if themes are
shared. shared.
Third Party Themes
------------------
.. cssclass:: longtable
+--------------------+--------------------+
| **Theme overview** | |
+--------------------+--------------------+
| |sphinx_rtd_theme| | |
| | |
| *sphinx_rtd_theme* | |
+--------------------+--------------------+
.. |sphinx_rtd_theme| image:: themes/sphinx_rtd_theme.png
* **sphinx_rtd_theme** -- `Read the Docs Sphinx Theme`_.
This is a mobile-friendly sphinx theme that was made for readthedocs.org.
View a working demo over on readthedocs.org. You can get install and options
information at `Read the Docs Sphinx Theme`_ page.
.. _Read the Docs Sphinx Theme: https://pypi.python.org/pypi/sphinx_rtd_theme
.. versionchanged:: 1.4
**sphinx_rtd_theme** has become optional.