Skip to content
This repository was archived by the owner on Feb 1, 2023. It is now read-only.

Commit 462f071

Browse files
committed
Fix documentation
1 parent 62b1c61 commit 462f071

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

src/doc/en/developer/tools.rst

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -10,24 +10,24 @@ Additional development and testing tools
1010

1111
Pytest
1212
===============================
13-
`Pytest <https://docs.pytest.org/en/stable/>` is a testing framework.
13+
`Pytest <https://docs.pytest.org/en/stable/>`_ is a testing framework.
1414
At the moment, Sage is not yet using any tests based on pytest.
1515

16-
*Installation:* ``pip install -U pytest``, see `documentation <https://docs.pytest.org/en/stable/getting-started.html#installation-and-getting-started>`_ for details.
16+
*Installation:* ``pip install -U pytest``, see `documentation <https://docs.pytest.org/en/stable/getting-started.html#installation-and-getting-started>`__ for details.
1717
*Usage:*
1818
- Manual: Run ``pytest path/to/the/test_file.py`` or ``pytest`` to run all tests (from a virtual environment with Sage installed)
19-
- VS Code: Install the `Python <https://marketplace.visualstudio.com/items?itemName=ms-python.python>`_ extension and follow the `offical documentation <https://code.visualstudio.com/docs/python/testing>`_.
19+
- VS Code: Install the `Python <https://marketplace.visualstudio.com/items?itemName=ms-python.python>`_ extension and follow the `offical VS Code documentation <https://code.visualstudio.com/docs/python/testing>`__.
2020
*Configuration:* ``conftest.py`` in the source folder
2121
*Documentation:* https://docs.pytest.org/en/stable/index.html
2222

2323
Pyright
2424
===============================
25-
`Pyright <https://github.com/microsoft/pyright>` is static type checker.
25+
`Pyright <https://github.com/microsoft/pyright>`_ is static type checker.
2626

27-
*Installation:* ``npm install -g pyright``, see `documentation <https://github.com/microsoft/pyright#installation>`_ for details.
27+
*Installation:* ``npm install -g pyright``, see `documentation <https://github.com/microsoft/pyright#installation>`__ for details.
2828
*Usage:*
2929
- Manual: Run ``pyright path/to/the/file.py``
30-
- VS Code: Install the `Pylance <https://marketplace.visualstudio.com/items?itemName=ms-python.vscode-pylance>`_ extension.
30+
- VS Code: Install the `Pylance <https://marketplace.visualstudio.com/items?itemName=ms-python.vscode-pylance>`__ extension.
3131
*Configuration:* ``pyrightconfig.json`` in the root
3232
*Note*: Currently, only the manifolds package is checked. Further packages can be added in the ``pyrightconfig.json`` file.
3333
*Documentation:* https://github.com/microsoft/pyright#documentation
@@ -39,7 +39,7 @@ Pycodestyle
3939
*Installation:* ``pip install -U pycodestyle --user``
4040
*Usage:*
4141
- Manual: Run ``pycodestyle path/to/the/file.py``
42-
- VS Code: Activate by adding the setting ``"python.linting.pycodestyleEnabled": true``, see `official VS Code documentation <https://code.visualstudio.com/docs/python/linting>`_ for details.
42+
- VS Code: Activate by adding the setting ``"python.linting.pycodestyleEnabled": true``, see `official VS Code documentation <https://code.visualstudio.com/docs/python/linting>`__ for details.
4343
*Configuration:* ``[pycodestyle]`` block in ``src/tox.ini``
4444
*Documentation:* https://pycodestyle.pycqa.org/en/latest/index.html
4545

0 commit comments

Comments
 (0)