mirror of
https://github.com/readthedocs/sphinx_rtd_theme.git
synced 2026-10-12 09:24:51 -05:00
Replace outdated information on installation page
Repoint compatibilities to development information page instead.
This commit is contained in:
2 files changed
+13
-18
No files matched your search
@@ -6,6 +6,8 @@ planning. Documentation authors can decide which theme release works best for
|
||||
their project based on required browser/operating system combinations or
|
||||
dependency support.
|
||||
|
||||
.. _supported-browsers:
|
||||
|
||||
Supported browsers
|
||||
------------------
|
||||
|
||||
@@ -46,6 +48,8 @@ Opera (any OS, any version)
|
||||
**Community support only.** We do not receive enough traffic with this
|
||||
browser to officially support it in testing and development.
|
||||
|
||||
.. _supported-dependencies:
|
||||
|
||||
Supported dependencies
|
||||
----------------------
|
||||
|
||||
@@ -57,6 +61,8 @@ The theme officially supports the following dependencies in your Sphinx project:
|
||||
|
||||
* - Dependency
|
||||
- Versions
|
||||
* - Python
|
||||
- 2.7 or 3.6 or greater
|
||||
* - Sphinx
|
||||
- 1.7 up to at least 4.1
|
||||
* - docutils
|
||||
|
||||
+7
-18
@@ -1,6 +1,5 @@
|
||||
************
|
||||
Installation
|
||||
************
|
||||
============
|
||||
|
||||
Install the package (or add it to your ``requirements.txt`` file):
|
||||
|
||||
@@ -21,6 +20,12 @@ In your ``conf.py`` file:
|
||||
|
||||
html_theme = "sphinx_rtd_theme"
|
||||
|
||||
.. seealso::
|
||||
:ref:`supported-browsers`
|
||||
Officially supported and tested browser/operating system combinations
|
||||
|
||||
:ref:`supported-dependencies`
|
||||
Officially Supported versions of Python, Sphinx, and other dependencies.
|
||||
|
||||
.. note::
|
||||
|
||||
@@ -45,19 +50,3 @@ Symlink or subtree the ``sphinx_rtd_theme/sphinx_rtd_theme`` repository into you
|
||||
|
||||
html_theme = "sphinx_rtd_theme"
|
||||
html_theme_path = ["_themes", ]
|
||||
|
||||
Compatibility
|
||||
=============
|
||||
|
||||
Python
|
||||
------
|
||||
|
||||
``sphinx_rtd_theme`` requires Python 2.7 or Python 3.4 or greater.
|
||||
|
||||
Sphinx
|
||||
------
|
||||
|
||||
``sphinx_rtd_theme`` depends on at least Sphinx 1.6 although,
|
||||
we recommend at least Sphinx 2 to take advantage of the html5 writer.
|
||||
The html4 writer is still supported however,
|
||||
it is deprecated and support will be removed in the near future.
|
||||
Reference in new issue
Block a user