diff options
| author | Anthony Johnson <aj@ohess.org> | 2021-08-17 23:33:19 +0300 |
|---|---|---|
| committer | Anthony Johnson <aj@ohess.org> | 2021-08-19 22:23:00 +0300 |
| commit | 022a58f68e2df3d1cd693a3be4630f5c450d15bb (patch) | |
| tree | 8f2efeb257590afbdf20e6e1dc606e0dbe1927e4 | |
| parent | c7d3a6ec2f436c248ba4123b60bbeec500d0c193 (diff) | |
Replace outdated information on installation page
Repoint compatibilities to development information page instead.
| -rw-r--r-- | docs/development.rst | 6 | ||||
| -rw-r--r-- | docs/installing.rst | 25 |
2 files changed, 13 insertions, 18 deletions
diff --git a/docs/development.rst b/docs/development.rst index 0745ce2..11845ed 100644 --- a/docs/development.rst +++ b/docs/development.rst @@ -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 diff --git a/docs/installing.rst b/docs/installing.rst index 61aaac1..49ca9a7 100644 --- a/docs/installing.rst +++ b/docs/installing.rst @@ -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. |