Skip to content

Commit 3df650c

Browse files
authored
Dos: update them based on addons updates (#11468)
* Dos: remove mention to injected context variables * Docs: remove "Edit on..." buttons guide We are not showing this by default anymore. People will need to add them manually. This is because we are not going to inject the Sphinx context anymore. * Docs: update default versions We not going to install `readthedocs-sphinx-ext` anymore soon.
1 parent 4dc78d5 commit 3df650c

File tree

4 files changed

+6
-72
lines changed

4 files changed

+6
-72
lines changed

docs/user/build-default-versions.rst

+2-12
Original file line numberDiff line numberDiff line change
@@ -10,10 +10,9 @@
1010
Default versions of dependencies
1111
================================
1212

13-
Read the Docs supports two tools to build your documentation:
13+
Read the Docs supports any documentation tool to build your documentation.
14+
However, we provide pre-defined builders for
1415
`Sphinx <https://www.sphinx-doc.org/>`__ and `MkDocs <https://www.mkdocs.org/>`__.
15-
In order to provide :doc:`several features </reference/features>`,
16-
Read the Docs injects or modifies some content while building your docs.
1716

1817
In the past we used to install several dependencies to a specific version and update them after some time,
1918
but doing so would break some builds and make it more difficult for new projects to use new versions.
@@ -76,12 +75,3 @@ pillow:
7675
recommonmark:
7776
Latest version by default installed via ``conda``.
7877
Projects created after August 7, 2023 won't install this dependency by default.
79-
80-
Internal dependencies
81-
---------------------
82-
83-
Internal dependencies are needed to integrate your docs with Read the Docs.
84-
We guarantee that these dependencies will work with all current supported versions of our tools,
85-
you don't need to specify them in your requirements.
86-
87-
- `readthedocs-sphinx-ext <https://github.com/readthedocs/readthedocs-sphinx-ext>`__

docs/user/guides/content/index.rst

+2-7
Original file line numberDiff line numberDiff line change
@@ -51,15 +51,10 @@ How-to guides: content, themes and SEO
5151
There are a number of use cases for embedding content,
5252
so we've built our integration in a way that enables users to build on top of it.
5353

54-
⏩️ :doc:`Removing "Edit on ..." buttons from documentation </guides/remove-edit-buttons>`
55-
When building your documentation,
56-
Read the Docs automatically adds buttons at the top of your documentation and in the versions menu that point readers to your repository to make changes.
57-
Here's how to remove it.
58-
5954
⏩️ :doc:`Adding "Edit Source" links on your Sphinx theme </guides/edit-source-links-sphinx>`
6055
Using your own theme?
61-
Read the Docs injects some extra variables in the Sphinx ``html_context``,
62-
some of which you can use to add an "edit source" link at the top of all pages.
56+
Add some extra variables in the Sphinx ``html_context``,
57+
to add an "edit source" link at the top of all pages.
6358

6459
.. toctree::
6560
:maxdepth: 1

docs/user/guides/edit-source-links-sphinx.rst

+2-3
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,8 @@
11
Adding "Edit Source" links on your Sphinx theme
22
===============================================
33

4-
Read the Docs injects some extra variables in the Sphinx ``html_context``
5-
that are used by `our Sphinx theme`_ to display "edit source" links at the top of all pages.
6-
You can use these variables in your own Sphinx theme as well.
4+
You can use define some Sphinx variables in the ``html_context`` to tell Read the Docs Sphinx theme
5+
to display "Edit Source" links on each page.
76

87
More information can be found on `Sphinx documentation`_.
98

docs/user/guides/remove-edit-buttons.rst

-50
This file was deleted.

0 commit comments

Comments
 (0)