Skip to content

Commit

Permalink
Docs: Remove "git install" method from instructions (#1375)
Browse files Browse the repository at this point in the history
* Remove instructions "encouraging" to install directly from git

* Update changelog: Add reminder that people should not install directly from git

* Update docs/changelog.rst

---------

Co-authored-by: Manuel Kaufmann <humitos@gmail.com>
  • Loading branch information
benjaoming and humitos committed Aug 22, 2023
1 parent 52e0cad commit 923f987
Showing 1 changed file with 0 additions and 18 deletions.
18 changes: 0 additions & 18 deletions docs/installing.rst
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", ]

0 comments on commit 923f987

Please sign in to comment.