Skip to content

Commit

Permalink
src/doc/en/developer/portability_testing.rst: Use .. NOTE::
Browse files Browse the repository at this point in the history
  • Loading branch information
kwankyu authored and mkoeppe committed Jan 22, 2024
1 parent ef155e4 commit aa7dab3
Showing 1 changed file with 14 additions and 19 deletions.
33 changes: 14 additions & 19 deletions src/doc/en/developer/portability_testing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -60,29 +60,24 @@ Make sure that your Docker client is configured to provide enough RAM
to the containers (8 GB are a good choice). In Docker Desktop this
setting is in Preferences -> Resources -> Advanced.

As an alternative, you can also run Docker in GitHub Codespaces
(or another cloud service) using a container with the Docker-in-Docker
feature. Sage provides a suitable dev container configuration
`.devcontainer/tox-docker-in-docker
<https://github.com/sagemath/sage/tree/develop/.devcontainer/tox-docker-in-docker>`_.

.. only:: html
.. NOTE::

.. |codespace-tox-docker-in-docker| image:: https://github.com/codespaces/badge.svg
:target: https://codespaces.new/sagemath/sage?devcontainer_path=.devcontainer%2Ftox-docker-in-docker%2Fdevcontainer.json
All examples in this section were obtained using Docker Desktop for
Mac; but the `command-line user interface
<https://docs.docker.com/engine/reference/commandline/cli/>`_ for the
other platforms is identical.

.. list-table::
:widths: 25 60
:header-rows: 0
As an alternative, you can also run Docker in GitHub Codespaces
(or another cloud service) using a container with the Docker-in-Docker
feature. Sage provides a suitable dev container configuration
`.devcontainer/tox-docker-in-docker
<https://github.com/sagemath/sage/tree/develop/.devcontainer/tox-docker-in-docker>`_:

* - `tox-docker-in-docker
<https://github.com/sagemath/sage/tree/develop/.devcontainer/tox-docker-in-docker>`_
- |codespace-tox-docker-in-docker|
.. ONLY:: html

All examples in this section were obtained using Docker Desktop for
Mac; but the `command-line user interface
<https://docs.docker.com/engine/reference/commandline/cli/>`_ for the
other platforms is identical.
.. image:: https://github.com/codespaces/badge.svg
:align: center
:target: https://codespaces.new/sagemath/sage?devcontainer_path=.devcontainer%2Ftox-docker-in-docker%2Fdevcontainer.json

All major Linux distributions provide ready-to-use Docker images,
which are published via `Docker Hub <https://hub.docker.com>`_
Expand Down

0 comments on commit aa7dab3

Please sign in to comment.