Skip to content

Fix links in docs from the build page refactor #9162

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 3, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/user/config-file/v2.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 <builds:external dependencies>`.
if your project was created before October 2020 <build-default-versions:external dependencies>`.

sphinx.builder
``````````````
Expand Down Expand Up @@ -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 <builds:external dependencies>`.
if your project was created before March 2021 <build-default-versions:external dependencies>`.

mkdocs.configuration
````````````````````
Expand Down
6 changes: 3 additions & 3 deletions docs/user/guides/conda.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 <builds: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.
Expand All @@ -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 <builds: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.
Expand Down Expand Up @@ -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 <builds: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
Expand Down
2 changes: 1 addition & 1 deletion docs/user/tutorial/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 <builds:Default versions of dependencies>`.
by :ref:`making some decisions on your behalf <build-default-versions:Default versions of dependencies>`.
For example, what Python version to use, how to install the requirements, and others.

.. tip::
Expand Down