🌐 AI搜索 & 代理 主页
Skip to content

Commit de6e548

Browse files
authored
Merge pull request #30810 from rcomer/rst-ci
Fix rstcheck failures
2 parents 7ebaad8 + a164f1e commit de6e548

File tree

6 files changed

+17
-21
lines changed

6 files changed

+17
-21
lines changed

doc/api/toolkits/mplot3d/faq.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,7 @@ mplot3d FAQ
66

77
How is mplot3d different from Mayavi?
88
=====================================
9-
`Mayavi <https://docs.enthought.com/mayavi/mayavi/>`_
10-
is a very powerful and featureful 3D graphing library. For advanced
9+
Mayavi_ is a very powerful and featureful 3D graphing library. For advanced
1110
3D scenes and excellent rendering capabilities, it is highly recommended to
1211
use Mayavi.
1312

@@ -37,8 +36,7 @@ rendered properly in matplotlib's 2D rendering engine.
3736

3837
This problem will likely not be solved until OpenGL support is added to all of
3938
the backends (patches are greatly welcomed). Until then, if you need complex
40-
3D scenes, we recommend using
41-
`MayaVi <https://docs.enthought.com/mayavi/mayavi/>`_.
39+
3D scenes, we recommend using Mayavi_.
4240

4341

4442
I don't like how the 3D plot is laid out, how do I change that?
@@ -49,3 +47,5 @@ Work is being done to eliminate this issue. For matplotlib v1.1.0, there is
4947
a semi-official manner to modify these parameters. See the note in the
5048
:mod:`.mplot3d.axis3d` section of the mplot3d API documentation for
5149
more information.
50+
51+
.. _Mayavi: https://docs.enthought.com/mayavi/mayavi/

doc/api/toolkits/mplot3d/view_angles.rst

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,7 @@ The position of the viewport "camera" in a 3D plot is defined by three angles:
1111
*elevation*, *azimuth*, and *roll*. From the resulting position, it always
1212
points towards the center of the plot box volume. The angle direction is a
1313
common convention, and is shared with
14-
`PyVista <https://docs.pyvista.org/api/core/camera.html>`_ and
15-
`MATLAB <https://www.mathworks.com/help/matlab/ref/view.html>`_.
14+
`PyVista <https://docs.pyvista.org/api/core/camera.html>`_ and MATLAB_.
1615
Note that a positive roll angle rotates the
1716
viewing plane clockwise, so the 3d axes will appear to rotate
1817
counter-clockwise.
@@ -51,8 +50,7 @@ can be specified by setting :rc:`axes3d.mouserotationstyle`, see
5150
:doc:`/users/explain/customizing`.
5251

5352
Prior to v3.10, the 2D mouse position corresponded directly
54-
to azimuth and elevation; this is also how it is done
55-
in `MATLAB <https://www.mathworks.com/help/matlab/ref/view.html>`_.
53+
to azimuth and elevation; this is also how it is done in MATLAB_.
5654
To keep it this way, set ``mouserotationstyle: azel``.
5755
This approach works fine for spherical coordinate plots, where the *z* axis is special;
5856
however, it leads to a kind of 'gimbal lock' when looking down the *z* axis:
@@ -131,7 +129,7 @@ Henriksen et al. [Henriksen2002]_ provide an overview. In summary:
131129
132130
You can try out one of the various mouse rotation styles using:
133131

134-
.. code::
132+
.. code-block:: python
135133
136134
import matplotlib as mpl
137135
mpl.rcParams['axes3d.mouserotationstyle'] = 'trackball' # 'azel', 'trackball', 'sphere', or 'arcball'
@@ -188,6 +186,7 @@ the arcball to the border occurs at 45°, set the border width to
188186
The border is a circular arc, wrapped around the arcball sphere cylindrically
189187
(like a doughnut), joined smoothly to the sphere, much like Bell's hyperbola.
190188

189+
.. _MATLAB: https://www.mathworks.com/help/matlab/ref/view.html
191190

192191
.. [Shoemake1992] Ken Shoemake, "ARCBALL: A user interface for specifying
193192
three-dimensional rotation using a mouse", in Proceedings of Graphics

doc/devel/contribute.rst

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -245,11 +245,11 @@ process works, technical questions about the code, what makes for good
245245
documentation or a blog post, how to get involved in community work, or get a
246246
"pre-review" on your PR.
247247

248-
To join, please go to our public community_ channel, and ask to be added to
248+
To join, please go to our public `community gitter`_ channel, and ask to be added to
249249
``#incubator``. One of our core developers will see your message and will add you.
250250

251251
.. _gitter: https://gitter.im/matplotlib/matplotlib
252-
.. _community: https://gitter.im/matplotlib/community
252+
.. _community gitter: https://gitter.im/matplotlib/community
253253

254254
.. _good_first_issues:
255255

@@ -313,10 +313,7 @@ active contributors, many of whom felt just like you when they started out and
313313
are happy to welcome you and support you as you get to know how we work, and
314314
where things are. You can reach out on any of our :ref:`communication-channels`.
315315
For development questions we recommend reaching out on our development gitter_
316-
chat room and for community questions reach out at community_.
317-
318-
.. _gitter: https://gitter.im/matplotlib/matplotlib
319-
.. _community: https://gitter.im/matplotlib/community
316+
chat room and for community questions reach out at `community gitter`_.
320317

321318
.. _managing_issues_prs:
322319

doc/devel/development_setup.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ Set up development environment
3838
==============================
3939

4040
You can either work locally on your machine, or online in
41-
`GitHub Codespaces <github-codespaces_>`_, a cloud-based in-browser development
41+
`GitHub Codespaces`_, a cloud-based in-browser development
4242
environment.
4343

4444

@@ -219,7 +219,7 @@ need to be installed when working in codespaces.
219219
Create GitHub Codespace :octicon:`codespaces`
220220
---------------------------------------------
221221

222-
`GitHub Codespaces <github-codespaces_>`_ is a cloud-based
222+
`GitHub Codespaces`_ is a cloud-based
223223
in-browser development environment that comes with the appropriate setup to
224224
contribute to Matplotlib.
225225

@@ -260,7 +260,7 @@ Use the "Extensions" icon in the activity bar to install the "Live Server"
260260
extension. Locate the ``doc/build/html`` folder in the Explorer, right click
261261
the file you want to open and select "Open with Live Server."
262262

263-
.. _`github-codespaces`: https://docs.github.com/codespaces
263+
.. _Github Codespaces: https://docs.github.com/codespaces
264264

265265
.. _development-install:
266266

doc/install/dependencies.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -234,7 +234,7 @@ means that the dependencies must be explicitly installed, either by :ref:`creati
234234
- `setuptools_scm <https://pypi.org/project/setuptools-scm/>`_ (>= 7). Used to
235235
update the reported ``mpl.__version__`` based on the current git commit.
236236
Also a runtime dependency for editable installs.
237-
- `NumPy <https://numpy.org>`_ (>= 1.22). Also a runtime dependency.
237+
- NumPy_ (>= 1.22). Also a runtime dependency.
238238

239239

240240
.. _compile-build-dependencies:
@@ -473,7 +473,7 @@ Optional
473473
The documentation can be built without Inkscape and optipng, but the build
474474
process will raise various warnings.
475475

476-
* `Inkscape <https://inkscape.org>`_
476+
* Inkscape_
477477
* `optipng <http://optipng.sourceforge.net>`_
478478
* the font `xkcd script <https://github.com/ipython/xkcd-font/>`_ or `Comic Neue <https://github.com/crozynski/comicneue>`_
479479
* the font "Times New Roman"

doc/install/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ Python distributions
7070

7171
Matplotlib is part of major Python distributions:
7272

73-
- `Anaconda <https://www.anaconda.com/>`_
73+
- Anaconda_
7474
- `ActiveState ActivePython
7575
<https://www.activestate.com/products/python/downloads/>`_
7676
- `WinPython <https://winpython.github.io/>`_

0 commit comments

Comments
 (0)