Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Docs: Remove "git install" method from instructions #1375

Merged
merged 4 commits into from
Aug 22, 2023
Merged

Docs: Remove "git install" method from instructions #1375

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
6e74280
Remove instructions "encouraging" to install directly from git
benjaoming Nov 9, 2022
4ff83ea
Update changelog: Add reminder that people should not install directl…
benjaoming Nov 9, 2022
ce56233
Update docs/changelog.rst
benjaoming Nov 14, 2022
111b31a
Merge branch 'master' of github.com:readthedocs/sphinx_rtd_theme into…
humitos Aug 22, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 6 additions & 1 deletion docs/changelog.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,15 @@ Changelog

.. seealso:: :ref:`howto_upgrade`

.. |development_version| replace:: 1.1.2alpha1

Development version (|development_version|)
===========================================

.. |development_version| replace:: 1.1.2alpha1
Deprecated
----------

* A reminder to not install the theme directly from Git, we will remove support for this in 3.0
benjaoming marked this conversation as resolved.
Show resolved Hide resolved

.. _release-1.1.1:

Expand Down
18 changes: 0 additions & 18 deletions docs/installing.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,21 +58,3 @@ Otherwise, pip will ignore pre-releases. Add for instance ``sphinx-rtd-theme==1.

More information is available in Read the Docs' documentation on :doc:`rtd:guides/reproducible-builds`.


Via Git or Download
-------------------

.. warning::

Installing directly from the repository source is deprecated and is not
recommended. Static assets won't be included in the repository starting in
release :ref:`roadmap-release-3.0.0`.

Symlink or subtree the ``sphinx_rtd_theme/sphinx_rtd_theme`` repository into your documentation at
``docs/_themes/sphinx_rtd_theme`` then add the following two settings to your Sphinx
``conf.py`` file:

.. code:: python

html_theme = "sphinx_rtd_theme"
html_theme_path = ["_themes", ]