diff --git a/docs/user/build-default-versions.rst b/docs/user/build-default-versions.rst index 4272ac62c8f..6ae87309b61 100644 --- a/docs/user/build-default-versions.rst +++ b/docs/user/build-default-versions.rst @@ -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 `__ and `MkDocs `__. -In order to provide :doc:`several 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. @@ -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 `__ diff --git a/docs/user/guides/content/index.rst b/docs/user/guides/content/index.rst index eef3722f31f..3973b526d8a 100644 --- a/docs/user/guides/content/index.rst +++ b/docs/user/guides/content/index.rst @@ -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 ` - 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 ` 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 diff --git a/docs/user/guides/edit-source-links-sphinx.rst b/docs/user/guides/edit-source-links-sphinx.rst index 3f6c4845489..7976ba0f731 100644 --- a/docs/user/guides/edit-source-links-sphinx.rst +++ b/docs/user/guides/edit-source-links-sphinx.rst @@ -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`_. diff --git a/docs/user/guides/remove-edit-buttons.rst b/docs/user/guides/remove-edit-buttons.rst deleted file mode 100644 index 9d10e155e9b..00000000000 --- a/docs/user/guides/remove-edit-buttons.rst +++ /dev/null @@ -1,50 +0,0 @@ -How to remove "Edit on ..." buttons from documentation -====================================================== - -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. For instance, if your repository is on GitHub, a button that says "Edit -on GitHub" is added in the top-right corner to your documentation to make it easy for readers to author -new changes. - - -Remove links from top-right corner ----------------------------------- - -The only way to remove these links currently is to override the Read the Docs -theme templates: - -* In your Sphinx project path, create a directory called ``_templates``. If you - use a different ``templates_path`` option in your ``conf.py``, substitute that - directory name. -* Create a file in this path called ``breadcrumbs.html`` - -The new ``breadcrumbs.html`` should look like this:: - - {%- extends "sphinx_rtd_theme/breadcrumbs.html" %} - - {% block breadcrumbs_aside %} - {% endblock %} - - -Remove "On ..." section from versions menu ------------------------------------------- - -This section can be removed with a custom CSS rule to hide them. -Follow the instructions under :doc:`adding-custom-css` and put the following content into the ``.css`` file: - -.. code-block:: css - - /* Hide "On GitHub" section from versions menu */ - div.rst-versions > div.rst-other-versions > div.injected > dl:nth-child(4) { - display: none; - } - - -.. warning:: - - You may need to change the ``4`` number in ``dl:nth-child(4)`` for a different one in case your project has more sections in the versions menu. - For example, if your project has translations into different languages, you will need to use the number ``5`` there. - -Now when you build your documentation, your documentation won't include an edit -button or links to the page source.