Skip to content

Commit

Permalink
Dos: update them based on addons updates (#11468)
Browse files Browse the repository at this point in the history
* 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.
  • Loading branch information
humitos authored Jul 16, 2024
1 parent 4dc78d5 commit 3df650c
Show file tree
Hide file tree
Showing 4 changed files with 6 additions and 72 deletions.
14 changes: 2 additions & 12 deletions docs/user/build-default-versions.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,10 +10,9 @@
Default versions of dependencies
================================

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

In the past we used to install several dependencies to a specific version and update them after some time,
but doing so would break some builds and make it more difficult for new projects to use new versions.
Expand Down Expand Up @@ -76,12 +75,3 @@ pillow:
recommonmark:
Latest version by default installed via ``conda``.
Projects created after August 7, 2023 won't install this dependency by default.

Internal dependencies
---------------------

Internal dependencies are needed to integrate your docs with Read the Docs.
We guarantee that these dependencies will work with all current supported versions of our tools,
you don't need to specify them in your requirements.

- `readthedocs-sphinx-ext <https://github.com/readthedocs/readthedocs-sphinx-ext>`__
9 changes: 2 additions & 7 deletions docs/user/guides/content/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -51,15 +51,10 @@ How-to guides: content, themes and SEO
There are a number of use cases for embedding content,
so we've built our integration in a way that enables users to build on top of it.

⏩️ :doc:`Removing "Edit on ..." buttons from documentation </guides/remove-edit-buttons>`
When building your documentation,
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.
Here's how to remove it.

⏩️ :doc:`Adding "Edit Source" links on your Sphinx theme </guides/edit-source-links-sphinx>`
Using your own theme?
Read the Docs injects some extra variables in the Sphinx ``html_context``,
some of which you can use to add an "edit source" link at the top of all pages.
Add some extra variables in the Sphinx ``html_context``,
to add an "edit source" link at the top of all pages.

.. toctree::
:maxdepth: 1
Expand Down
5 changes: 2 additions & 3 deletions docs/user/guides/edit-source-links-sphinx.rst
Original file line number Diff line number Diff line change
@@ -1,9 +1,8 @@
Adding "Edit Source" links on your Sphinx theme
===============================================

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

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

Expand Down
50 changes: 0 additions & 50 deletions docs/user/guides/remove-edit-buttons.rst

This file was deleted.

0 comments on commit 3df650c

Please sign in to comment.