From e59efddd083136a7299689e8ee55081c7b606fed Mon Sep 17 00:00:00 2001 From: Eric Holscher Date: Tue, 3 May 2022 15:17:02 -0700 Subject: [PATCH] Fix links in docs from the build page refactor --- docs/user/config-file/v2.rst | 4 ++-- docs/user/guides/conda.rst | 6 +++--- docs/user/tutorial/index.rst | 2 +- 3 files changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/user/config-file/v2.rst b/docs/user/config-file/v2.rst index d1833cb3968..ff52f4b04dc 100644 --- a/docs/user/config-file/v2.rst +++ b/docs/user/config-file/v2.rst @@ -479,7 +479,7 @@ Configuration for Sphinx documentation you can use the ``extra_requirements`` option (see :ref:`config-file/v2:packages`). This also allows you to override :ref:`the default pinning done by Read the Docs - if your project was created before October 2020 `. + if your project was created before October 2020 `. sphinx.builder `````````````` @@ -537,7 +537,7 @@ Configuration for MkDocs documentation. you can use the ``extra_requirements`` option (see :ref:`config-file/v2:packages`). This also allows you to override :ref:`the default pinning done by Read the Docs - if your project was created before March 2021 `. + if your project was created before March 2021 `. mkdocs.configuration ```````````````````` diff --git a/docs/user/guides/conda.rst b/docs/user/guides/conda.rst index 1f069a49d7f..5da5c77406f 100644 --- a/docs/user/guides/conda.rst +++ b/docs/user/guides/conda.rst @@ -15,7 +15,7 @@ Activating Conda Conda support is available using a :doc:`../config-file/index`, see :ref:`config-file/v2:conda`. -Our :ref:`Docker images ` use Miniconda, a minimal conda installer. +Our Docker images use Miniconda, a minimal conda installer. After specifying your project requirements using a conda ``environment.yml`` file, Read the Docs will create the environment (using ``conda env create``) and add the core dependencies needed to build the documentation. @@ -28,7 +28,7 @@ There are several ways of `exporting a conda environment`_: - ``conda env export`` will produce a complete list of all the packages installed in the environment with their exact versions. This is the best option to ensure reproducibility, but can create problems if done from a different operative system than the target machine, - in our case Ubuntu Linux (check out our :ref:`Docker images ` for further information). + in our case Ubuntu Linux. - ``conda env export --from-history`` will only include packages that were explicitly requested in the environment, excluding the transitive dependencies. This is the best option to maximize cross-platform compatibility, however it may include packages that are not needed to build your docs. @@ -175,7 +175,7 @@ Compiling your project sources If your project contains extension modules written in a compiled language (C, C++, FORTRAN) or server-side JavaScript, you might need special tools to build it from source -that are not readily available on our :ref:`Docker images `, +that are not readily available on our Docker images, such as a suitable compiler, CMake, Node.js, and others. Luckily, conda is a language-agnostic package manager, and many of these development tools diff --git a/docs/user/tutorial/index.rst b/docs/user/tutorial/index.rst index dc8607159aa..598fbefad16 100644 --- a/docs/user/tutorial/index.rst +++ b/docs/user/tutorial/index.rst @@ -299,7 +299,7 @@ This has several advantages: - Some configurations are only available using the config file. Read the Docs works without this configuration -by :ref:`making some decisions on your behalf `. +by :ref:`making some decisions on your behalf `. For example, what Python version to use, how to install the requirements, and others. .. tip::