Merge pull request #4733 from nulano/refs-mod

Fix documentation references: modules
python-pillow · Jun 29, 2020 · 20282dd · 20282dd
2 parents 8f91053 + 2761a02
commit 20282dd
Show file tree

Hide file tree

Showing 31 changed files with 194 additions and 194 deletions.
diff --git a/docs/PIL.rst b/docs/PIL.rst
@@ -12,81 +12,81 @@ can be found here.
 .. autoexception:: UnidentifiedImageError
     :show-inheritance:
 
-:mod:`BdfFontFile` Module
--------------------------
+:mod:`~PIL.BdfFontFile` Module
+------------------------------
 
 .. automodule:: PIL.BdfFontFile
     :members:
     :undoc-members:
     :show-inheritance:
 
-:mod:`ContainerIO` Module
--------------------------
+:mod:`~PIL.ContainerIO` Module
+------------------------------
 
 .. automodule:: PIL.ContainerIO
     :members:
     :undoc-members:
     :show-inheritance:
 
-:mod:`FontFile` Module
-----------------------
+:mod:`~PIL.FontFile` Module
+---------------------------
 
 .. automodule:: PIL.FontFile
     :members:
     :undoc-members:
     :show-inheritance:
 
-:mod:`GdImageFile` Module
--------------------------
+:mod:`~PIL.GdImageFile` Module
+------------------------------
 
 .. automodule:: PIL.GdImageFile
     :members:
     :undoc-members:
     :show-inheritance:
 
-:mod:`GimpGradientFile` Module
-------------------------------
+:mod:`~PIL.GimpGradientFile` Module
+-----------------------------------
 
 .. automodule:: PIL.GimpGradientFile
     :members:
     :undoc-members:
     :show-inheritance:
 
-:mod:`GimpPaletteFile` Module
------------------------------
+:mod:`~PIL.GimpPaletteFile` Module
+----------------------------------
 
 .. automodule:: PIL.GimpPaletteFile
     :members:
     :undoc-members:
     :show-inheritance:
 
-:mod:`ImageDraw2` Module
-------------------------
+:mod:`~PIL.ImageDraw2` Module
+-----------------------------
 
 .. automodule:: PIL.ImageDraw2
     :members:
     :member-order: bysource
     :undoc-members:
     :show-inheritance:
 
-:mod:`ImageTransform` Module
-----------------------------
+:mod:`~PIL.ImageTransform` Module
+---------------------------------
 
 .. automodule:: PIL.ImageTransform
     :members:
     :undoc-members:
     :show-inheritance:
 
-:mod:`PaletteFile` Module
--------------------------
+:mod:`~PIL.PaletteFile` Module
+------------------------------
 
 .. automodule:: PIL.PaletteFile
     :members:
     :undoc-members:
     :show-inheritance:
 
-:mod:`PcfFontFile` Module
--------------------------
+:mod:`~PIL.PcfFontFile` Module
+------------------------------
 
 .. automodule:: PIL.PcfFontFile
     :members:
@@ -116,16 +116,16 @@ can be found here.
     :show-inheritance:
 
 
-:mod:`TarIO` Module
--------------------
+:mod:`~PIL.TarIO` Module
+------------------------
 
 .. automodule:: PIL.TarIO
     :members:
     :undoc-members:
     :show-inheritance:
 
-:mod:`WalImageFile` Module
---------------------------
+:mod:`~PIL.WalImageFile` Module
+-------------------------------
 
 .. automodule:: PIL.WalImageFile
     :members:

diff --git a/docs/porting.rst b/docs/porting.rst
@@ -19,7 +19,7 @@ to this::
 
     from PIL import Image
 
-The :py:mod:`_imaging` module has been moved. You can now import it like this::
+The :py:mod:`~PIL._imaging` module has been moved. You can now import it like this::
 
     from PIL.Image import core as _imaging
 

diff --git a/docs/reference/ExifTags.rst b/docs/reference/ExifTags.rst
@@ -1,10 +1,10 @@
 .. py:module:: PIL.ExifTags
 .. py:currentmodule:: PIL.ExifTags
 
-:py:mod:`ExifTags` Module
-==========================
+:py:mod:`~PIL.ExifTags` Module
+==============================
 
-The :py:mod:`ExifTags` module exposes two dictionaries which
+The :py:mod:`~PIL.ExifTags` module exposes two dictionaries which
 provide constants and clear-text names for various well-known EXIF tags.
 
 .. py:data:: TAGS

diff --git a/docs/reference/Image.rst b/docs/reference/Image.rst
@@ -1,8 +1,8 @@
 .. py:module:: PIL.Image
 .. py:currentmodule:: PIL.Image
 
-:py:mod:`Image` Module
-======================
+:py:mod:`~PIL.Image` Module
+===========================
 
 The :py:mod:`~PIL.Image` module provides a class with the same name which is
 used to represent a PIL image. The module also provides a number of factory

diff --git a/docs/reference/ImageChops.rst b/docs/reference/ImageChops.rst
@@ -1,15 +1,15 @@
 .. py:module:: PIL.ImageChops
 .. py:currentmodule:: PIL.ImageChops
 
-:py:mod:`ImageChops` ("Channel Operations") Module
-==================================================
+:py:mod:`~PIL.ImageChops` ("Channel Operations") Module
+=======================================================
 
-The :py:mod:`ImageChops` module contains a number of arithmetical image
+The :py:mod:`~PIL.ImageChops` module contains a number of arithmetical image
 operations, called channel operations (“chops”). These can be used for various
 purposes, including special effects, image compositions, algorithmic painting,
 and more.
 
-For more pre-made operations, see :py:mod:`ImageOps`.
+For more pre-made operations, see :py:mod:`~PIL.ImageOps`.
 
 At this time, most channel operations are only implemented for 8-bit images
 (e.g. “L” and “RGB”).

diff --git a/docs/reference/ImageCms.rst b/docs/reference/ImageCms.rst
@@ -1,10 +1,10 @@
 .. py:module:: PIL.ImageCms
 .. py:currentmodule:: PIL.ImageCms
 
-:py:mod:`ImageCms` Module
-=========================
+:py:mod:`~PIL.ImageCms` Module
+==============================
 
-The :py:mod:`ImageCms` module provides color profile management
+The :py:mod:`~PIL.ImageCms` module provides color profile management
 support using the LittleCMS2 color management engine, based on Kevin
 Cazabon's PyCMS library.
 

diff --git a/docs/reference/ImageColor.rst b/docs/reference/ImageColor.rst
@@ -1,10 +1,10 @@
 .. py:module:: PIL.ImageColor
 .. py:currentmodule:: PIL.ImageColor
 
-:py:mod:`ImageColor` Module
-===========================
+:py:mod:`~PIL.ImageColor` Module
+================================
 
-The :py:mod:`ImageColor` module contains color tables and converters from
+The :py:mod:`~PIL.ImageColor` module contains color tables and converters from
 CSS3-style color specifiers to RGB tuples. This module is used by
 :py:meth:`PIL.Image.new` and the :py:mod:`~PIL.ImageDraw` module, among
 others.

diff --git a/docs/reference/ImageDraw.rst b/docs/reference/ImageDraw.rst
@@ -1,10 +1,10 @@
 .. py:module:: PIL.ImageDraw
 .. py:currentmodule:: PIL.ImageDraw
 
-:py:mod:`ImageDraw` Module
-==========================
+:py:mod:`~PIL.ImageDraw` Module
+===============================
 
-The :py:mod:`ImageDraw` module provides simple 2D graphics for
+The :py:mod:`~PIL.ImageDraw` module provides simple 2D graphics for
 :py:class:`~PIL.Image.Image` objects.  You can use this module to create new
 images, annotate or retouch existing images, and to generate graphics on the
 fly for web use.

diff --git a/docs/reference/ImageEnhance.rst b/docs/reference/ImageEnhance.rst
@@ -1,10 +1,10 @@
 .. py:module:: PIL.ImageEnhance
 .. py:currentmodule:: PIL.ImageEnhance
 
-:py:mod:`ImageEnhance` Module
-=============================
+:py:mod:`~PIL.ImageEnhance` Module
+==================================
 
-The :py:mod:`ImageEnhance` module contains a number of classes that can be used
+The :py:mod:`~PIL.ImageEnhance` module contains a number of classes that can be used
 for image enhancement.
 
 Example: Vary the sharpness of an image

diff --git a/docs/reference/ImageFile.rst b/docs/reference/ImageFile.rst
@@ -1,10 +1,10 @@
 .. py:module:: PIL.ImageFile
 .. py:currentmodule:: PIL.ImageFile
 
-:py:mod:`ImageFile` Module
-==========================
+:py:mod:`~PIL.ImageFile` Module
+===============================
 
-The :py:mod:`ImageFile` module provides support functions for the image open
+The :py:mod:`~PIL.ImageFile` module provides support functions for the image open
 and save functions.
 
 In addition, it provides a :py:class:`Parser` class which can be used to decode

diff --git a/docs/reference/ImageFilter.rst b/docs/reference/ImageFilter.rst
@@ -1,10 +1,10 @@
 .. py:module:: PIL.ImageFilter
 .. py:currentmodule:: PIL.ImageFilter
 
-:py:mod:`ImageFilter` Module
-============================
+:py:mod:`~PIL.ImageFilter` Module
+=================================
 
-The :py:mod:`ImageFilter` module contains definitions for a pre-defined set of
+The :py:mod:`~PIL.ImageFilter` module contains definitions for a pre-defined set of
 filters, which can be be used with the :py:meth:`Image.filter()
 <PIL.Image.Image.filter>` method.
 

diff --git a/docs/reference/ImageFont.rst b/docs/reference/ImageFont.rst
@@ -1,10 +1,10 @@
 .. py:module:: PIL.ImageFont
 .. py:currentmodule:: PIL.ImageFont
 
-:py:mod:`ImageFont` Module
-==========================
+:py:mod:`~PIL.ImageFont` Module
+===============================
 
-The :py:mod:`ImageFont` module defines a class with the same name. Instances of
+The :py:mod:`~PIL.ImageFont` module defines a class with the same name. Instances of
 this class store bitmap fonts, and are used with the
 :py:meth:`PIL.ImageDraw.Draw.text` method.
 

diff --git a/docs/reference/ImageGrab.rst b/docs/reference/ImageGrab.rst
@@ -1,10 +1,10 @@
 .. py:module:: PIL.ImageGrab
 .. py:currentmodule:: PIL.ImageGrab
 
-:py:mod:`ImageGrab` Module
-==========================
+:py:mod:`~PIL.ImageGrab` Module
+===============================
 
-The :py:mod:`ImageGrab` module can be used to copy the contents of the screen
+The :py:mod:`~PIL.ImageGrab` module can be used to copy the contents of the screen
 or the clipboard to a PIL image memory.
 
 .. versionadded:: 1.1.3

diff --git a/docs/reference/ImageMath.rst b/docs/reference/ImageMath.rst
@@ -1,10 +1,10 @@
 .. py:module:: PIL.ImageMath
 .. py:currentmodule:: PIL.ImageMath
 
-:py:mod:`ImageMath` Module
-==========================
+:py:mod:`~PIL.ImageMath` Module
+===============================
 
-The :py:mod:`ImageMath` module can be used to evaluate “image expressions”. The
+The :py:mod:`~PIL.ImageMath` module can be used to evaluate “image expressions”. The
 module provides a single :py:meth:`~PIL.ImageMath.eval` function, which takes
 an expression string and one or more images.
 

diff --git a/docs/reference/ImageMorph.rst b/docs/reference/ImageMorph.rst
@@ -1,10 +1,10 @@
 .. py:module:: PIL.ImageMorph
 .. py:currentmodule:: PIL.ImageMorph
 
-:py:mod:`ImageMorph` Module
-===========================
+:py:mod:`~PIL.ImageMorph` Module
+================================
 
-The :py:mod:`ImageMorph` module provides morphology operations on images.
+The :py:mod:`~PIL.ImageMorph` module provides morphology operations on images.
 
 .. automodule:: PIL.ImageMorph
     :members:

diff --git a/docs/reference/ImageOps.rst b/docs/reference/ImageOps.rst
@@ -1,10 +1,10 @@
 .. py:module:: PIL.ImageOps
 .. py:currentmodule:: PIL.ImageOps
 
-:py:mod:`ImageOps` Module
-==========================
+:py:mod:`~PIL.ImageOps` Module
+==============================
 
-The :py:mod:`ImageOps` module contains a number of ‘ready-made’ image
+The :py:mod:`~PIL.ImageOps` module contains a number of ‘ready-made’ image
 processing operations. This module is somewhat experimental, and most operators
 only work on L and RGB images.
 

diff --git a/docs/reference/ImagePalette.rst b/docs/reference/ImagePalette.rst
@@ -1,10 +1,10 @@
 .. py:module:: PIL.ImagePalette
 .. py:currentmodule:: PIL.ImagePalette
 
-:py:mod:`ImagePalette` Module
-=============================
+:py:mod:`~PIL.ImagePalette` Module
+==================================
 
-The :py:mod:`ImagePalette` module contains a class of the same name to
+The :py:mod:`~PIL.ImagePalette` module contains a class of the same name to
 represent the color palette of palette mapped images.
 
 .. note::

diff --git a/docs/reference/ImagePath.rst b/docs/reference/ImagePath.rst
@@ -1,10 +1,10 @@
 .. py:module:: PIL.ImagePath
 .. py:currentmodule:: PIL.ImagePath
 
-:py:mod:`ImagePath` Module
-==========================
+:py:mod:`~PIL.ImagePath` Module
+===============================
 
-The :py:mod:`ImagePath` module is used to store and manipulate 2-dimensional
+The :py:mod:`~PIL.ImagePath` module is used to store and manipulate 2-dimensional
 vector data. Path objects can be passed to the methods on the
 :py:mod:`~PIL.ImageDraw` module.
 

diff --git a/docs/reference/ImageQt.rst b/docs/reference/ImageQt.rst
@@ -1,10 +1,10 @@
 .. py:module:: PIL.ImageQt
 .. py:currentmodule:: PIL.ImageQt
 
-:py:mod:`ImageQt` Module
-========================
+:py:mod:`~PIL.ImageQt` Module
+=============================
 
-The :py:mod:`ImageQt` module contains support for creating PyQt5 or PySide2 QImage
+The :py:mod:`~PIL.ImageQt` module contains support for creating PyQt5 or PySide2 QImage
 objects from PIL images.
 
 .. versionadded:: 1.1.6

diff --git a/docs/reference/ImageSequence.rst b/docs/reference/ImageSequence.rst
@@ -1,10 +1,10 @@
 .. py:module:: PIL.ImageSequence
 .. py:currentmodule:: PIL.ImageSequence
 
-:py:mod:`ImageSequence` Module
-==============================
+:py:mod:`~PIL.ImageSequence` Module
+===================================
 
-The :py:mod:`ImageSequence` module contains a wrapper class that lets you
+The :py:mod:`~PIL.ImageSequence` module contains a wrapper class that lets you
 iterate over the frames of an image sequence.
 
 Extracting frames from an animation