From 869942d498e64b751c56994b39716ba570d04e0c Mon Sep 17 00:00:00 2001 From: Steve Johnson Date: Sun, 6 Oct 2013 21:14:13 -0700 Subject: [PATCH] Split API reference into PIL vs plugins --- docs/PIL.rst | 328 ---------------------------------------------- docs/index.rst | 1 + docs/plugins.rst | 330 +++++++++++++++++++++++++++++++++++++++++++++++ 3 files changed, 331 insertions(+), 328 deletions(-) create mode 100644 docs/plugins.rst diff --git a/docs/PIL.rst b/docs/PIL.rst index 870b896fa..8f1509f2c 100644 --- a/docs/PIL.rst +++ b/docs/PIL.rst @@ -9,14 +9,6 @@ PIL Package :undoc-members: :show-inheritance: -:mod:`ArgImagePlugin` Module ----------------------------- - -.. automodule:: PIL.ArgImagePlugin - :members: - :undoc-members: - :show-inheritance: - :mod:`BdfFontFile` Module ------------------------- @@ -25,22 +17,6 @@ PIL Package :undoc-members: :show-inheritance: -:mod:`BmpImagePlugin` Module ----------------------------- - -.. automodule:: PIL.BmpImagePlugin - :members: - :undoc-members: - :show-inheritance: - -:mod:`BufrStubImagePlugin` Module ---------------------------------- - -.. automodule:: PIL.BufrStubImagePlugin - :members: - :undoc-members: - :show-inheritance: - :mod:`ContainerIO` Module ------------------------- @@ -49,30 +25,6 @@ PIL Package :undoc-members: :show-inheritance: -:mod:`CurImagePlugin` Module ----------------------------- - -.. automodule:: PIL.CurImagePlugin - :members: - :undoc-members: - :show-inheritance: - -:mod:`DcxImagePlugin` Module ----------------------------- - -.. automodule:: PIL.DcxImagePlugin - :members: - :undoc-members: - :show-inheritance: - -:mod:`EpsImagePlugin` Module ----------------------------- - -.. automodule:: PIL.EpsImagePlugin - :members: - :undoc-members: - :show-inheritance: - :mod:`ExifTags` Module ---------------------- @@ -81,22 +33,6 @@ PIL Package :undoc-members: :show-inheritance: -:mod:`FitsStubImagePlugin` Module ---------------------------------- - -.. automodule:: PIL.FitsStubImagePlugin - :members: - :undoc-members: - :show-inheritance: - -:mod:`FliImagePlugin` Module ----------------------------- - -.. automodule:: PIL.FliImagePlugin - :members: - :undoc-members: - :show-inheritance: - :mod:`FontFile` Module ---------------------- @@ -105,22 +41,6 @@ PIL Package :undoc-members: :show-inheritance: -:mod:`FpxImagePlugin` Module ----------------------------- - -.. automodule:: PIL.FpxImagePlugin - :members: - :undoc-members: - :show-inheritance: - -:mod:`GbrImagePlugin` Module ----------------------------- - -.. automodule:: PIL.GbrImagePlugin - :members: - :undoc-members: - :show-inheritance: - :mod:`GdImageFile` Module ------------------------- @@ -129,14 +49,6 @@ PIL Package :undoc-members: :show-inheritance: -:mod:`GifImagePlugin` Module ----------------------------- - -.. automodule:: PIL.GifImagePlugin - :members: - :undoc-members: - :show-inheritance: - :mod:`GimpGradientFile` Module ------------------------------ @@ -153,46 +65,6 @@ PIL Package :undoc-members: :show-inheritance: -:mod:`GribStubImagePlugin` Module ---------------------------------- - -.. automodule:: PIL.GribStubImagePlugin - :members: - :undoc-members: - :show-inheritance: - -:mod:`Hdf5StubImagePlugin` Module ---------------------------------- - -.. automodule:: PIL.Hdf5StubImagePlugin - :members: - :undoc-members: - :show-inheritance: - -:mod:`IcnsImagePlugin` Module ------------------------------ - -.. automodule:: PIL.IcnsImagePlugin - :members: - :undoc-members: - :show-inheritance: - -:mod:`IcoImagePlugin` Module ----------------------------- - -.. automodule:: PIL.IcoImagePlugin - :members: - :undoc-members: - :show-inheritance: - -:mod:`ImImagePlugin` Module ---------------------------- - -.. automodule:: PIL.ImImagePlugin - :members: - :undoc-members: - :show-inheritance: - :mod:`Image` Module ------------------- @@ -377,30 +249,6 @@ PIL Package :undoc-members: :show-inheritance: -:mod:`ImtImagePlugin` Module ----------------------------- - -.. automodule:: PIL.ImtImagePlugin - :members: - :undoc-members: - :show-inheritance: - -:mod:`IptcImagePlugin` Module ------------------------------ - -.. automodule:: PIL.IptcImagePlugin - :members: - :undoc-members: - :show-inheritance: - -:mod:`JpegImagePlugin` Module ------------------------------ - -.. automodule:: PIL.JpegImagePlugin - :members: - :undoc-members: - :show-inheritance: - :mod:`JpegPresets` Module ------------------------- @@ -409,38 +257,6 @@ PIL Package :undoc-members: :show-inheritance: -:mod:`McIdasImagePlugin` Module -------------------------------- - -.. automodule:: PIL.McIdasImagePlugin - :members: - :undoc-members: - :show-inheritance: - -:mod:`MicImagePlugin` Module ----------------------------- - -.. automodule:: PIL.MicImagePlugin - :members: - :undoc-members: - :show-inheritance: - -:mod:`MpegImagePlugin` Module ------------------------------ - -.. automodule:: PIL.MpegImagePlugin - :members: - :undoc-members: - :show-inheritance: - -:mod:`MspImagePlugin` Module ----------------------------- - -.. automodule:: PIL.MspImagePlugin - :members: - :undoc-members: - :show-inheritance: - :mod:`OleFileIO` Module ----------------------- @@ -465,22 +281,6 @@ PIL Package :undoc-members: :show-inheritance: -:mod:`PalmImagePlugin` Module ------------------------------ - -.. automodule:: PIL.PalmImagePlugin - :members: - :undoc-members: - :show-inheritance: - -:mod:`PcdImagePlugin` Module ----------------------------- - -.. automodule:: PIL.PcdImagePlugin - :members: - :undoc-members: - :show-inheritance: - :mod:`PcfFontFile` Module ------------------------- @@ -489,78 +289,6 @@ PIL Package :undoc-members: :show-inheritance: -:mod:`PcxImagePlugin` Module ----------------------------- - -.. automodule:: PIL.PcxImagePlugin - :members: - :undoc-members: - :show-inheritance: - -:mod:`PdfImagePlugin` Module ----------------------------- - -.. automodule:: PIL.PdfImagePlugin - :members: - :undoc-members: - :show-inheritance: - -:mod:`PixarImagePlugin` Module ------------------------------- - -.. automodule:: PIL.PixarImagePlugin - :members: - :undoc-members: - :show-inheritance: - -:mod:`PngImagePlugin` Module ----------------------------- - -.. automodule:: PIL.PngImagePlugin - :members: - :undoc-members: - :show-inheritance: - -:mod:`PpmImagePlugin` Module ----------------------------- - -.. automodule:: PIL.PpmImagePlugin - :members: - :undoc-members: - :show-inheritance: - -:mod:`PsdImagePlugin` Module ----------------------------- - -.. automodule:: PIL.PsdImagePlugin - :members: - :undoc-members: - :show-inheritance: - -:mod:`SgiImagePlugin` Module ----------------------------- - -.. automodule:: PIL.SgiImagePlugin - :members: - :undoc-members: - :show-inheritance: - -:mod:`SpiderImagePlugin` Module -------------------------------- - -.. automodule:: PIL.SpiderImagePlugin - :members: - :undoc-members: - :show-inheritance: - -:mod:`SunImagePlugin` Module ----------------------------- - -.. automodule:: PIL.SunImagePlugin - :members: - :undoc-members: - :show-inheritance: - :mod:`TarIO` Module ------------------- @@ -569,22 +297,6 @@ PIL Package :undoc-members: :show-inheritance: -:mod:`TgaImagePlugin` Module ----------------------------- - -.. automodule:: PIL.TgaImagePlugin - :members: - :undoc-members: - :show-inheritance: - -:mod:`TiffImagePlugin` Module ------------------------------ - -.. automodule:: PIL.TiffImagePlugin - :members: - :undoc-members: - :show-inheritance: - :mod:`TiffTags` Module ---------------------- @@ -601,46 +313,6 @@ PIL Package :undoc-members: :show-inheritance: -:mod:`WebPImagePlugin` Module ------------------------------ - -.. automodule:: PIL.WebPImagePlugin - :members: - :undoc-members: - :show-inheritance: - -:mod:`WmfImagePlugin` Module ----------------------------- - -.. automodule:: PIL.WmfImagePlugin - :members: - :undoc-members: - :show-inheritance: - -:mod:`XVThumbImagePlugin` Module --------------------------------- - -.. automodule:: PIL.XVThumbImagePlugin - :members: - :undoc-members: - :show-inheritance: - -:mod:`XbmImagePlugin` Module ----------------------------- - -.. automodule:: PIL.XbmImagePlugin - :members: - :undoc-members: - :show-inheritance: - -:mod:`XpmImagePlugin` Module ----------------------------- - -.. automodule:: PIL.XpmImagePlugin - :members: - :undoc-members: - :show-inheritance: - :mod:`_binary` Module --------------------- diff --git a/docs/index.rst b/docs/index.rst index 6be9de8a0..7d9e69067 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -7,6 +7,7 @@ Pillow: a modern fork of PIL handbook/guides.rst handbook/appendices.rst PIL + plugins Indices and tables ================== diff --git a/docs/plugins.rst b/docs/plugins.rst new file mode 100644 index 000000000..b92b500c1 --- /dev/null +++ b/docs/plugins.rst @@ -0,0 +1,330 @@ +Plugin reference +================ + +:mod:`ArgImagePlugin` Module +---------------------------- + +.. automodule:: PIL.ArgImagePlugin + :members: + :undoc-members: + :show-inheritance: + +:mod:`BmpImagePlugin` Module +---------------------------- + +.. automodule:: PIL.BmpImagePlugin + :members: + :undoc-members: + :show-inheritance: + +:mod:`BufrStubImagePlugin` Module +--------------------------------- + +.. automodule:: PIL.BufrStubImagePlugin + :members: + :undoc-members: + :show-inheritance: + +:mod:`CurImagePlugin` Module +---------------------------- + +.. automodule:: PIL.CurImagePlugin + :members: + :undoc-members: + :show-inheritance: + +:mod:`DcxImagePlugin` Module +---------------------------- + +.. automodule:: PIL.DcxImagePlugin + :members: + :undoc-members: + :show-inheritance: + +:mod:`EpsImagePlugin` Module +---------------------------- + +.. automodule:: PIL.EpsImagePlugin + :members: + :undoc-members: + :show-inheritance: + +:mod:`FitsStubImagePlugin` Module +--------------------------------- + +.. automodule:: PIL.FitsStubImagePlugin + :members: + :undoc-members: + :show-inheritance: + +:mod:`FliImagePlugin` Module +---------------------------- + +.. automodule:: PIL.FliImagePlugin + :members: + :undoc-members: + :show-inheritance: + +:mod:`FpxImagePlugin` Module +---------------------------- + +.. automodule:: PIL.FpxImagePlugin + :members: + :undoc-members: + :show-inheritance: + +:mod:`GbrImagePlugin` Module +---------------------------- + +.. automodule:: PIL.GbrImagePlugin + :members: + :undoc-members: + :show-inheritance: + +:mod:`GifImagePlugin` Module +---------------------------- + +.. automodule:: PIL.GifImagePlugin + :members: + :undoc-members: + :show-inheritance: + +:mod:`GribStubImagePlugin` Module +--------------------------------- + +.. automodule:: PIL.GribStubImagePlugin + :members: + :undoc-members: + :show-inheritance: + +:mod:`Hdf5StubImagePlugin` Module +--------------------------------- + +.. automodule:: PIL.Hdf5StubImagePlugin + :members: + :undoc-members: + :show-inheritance: + +:mod:`IcnsImagePlugin` Module +----------------------------- + +.. automodule:: PIL.IcnsImagePlugin + :members: + :undoc-members: + :show-inheritance: + +:mod:`IcoImagePlugin` Module +---------------------------- + +.. automodule:: PIL.IcoImagePlugin + :members: + :undoc-members: + :show-inheritance: + +:mod:`ImImagePlugin` Module +--------------------------- + +.. automodule:: PIL.ImImagePlugin + :members: + :undoc-members: + :show-inheritance: + +:mod:`ImtImagePlugin` Module +---------------------------- + +.. automodule:: PIL.ImtImagePlugin + :members: + :undoc-members: + :show-inheritance: + +:mod:`IptcImagePlugin` Module +----------------------------- + +.. automodule:: PIL.IptcImagePlugin + :members: + :undoc-members: + :show-inheritance: + +:mod:`JpegImagePlugin` Module +----------------------------- + +.. automodule:: PIL.JpegImagePlugin + :members: + :undoc-members: + :show-inheritance: + +:mod:`McIdasImagePlugin` Module +------------------------------- + +.. automodule:: PIL.McIdasImagePlugin + :members: + :undoc-members: + :show-inheritance: + +:mod:`MicImagePlugin` Module +---------------------------- + +.. automodule:: PIL.MicImagePlugin + :members: + :undoc-members: + :show-inheritance: + +:mod:`MpegImagePlugin` Module +----------------------------- + +.. automodule:: PIL.MpegImagePlugin + :members: + :undoc-members: + :show-inheritance: + +:mod:`MspImagePlugin` Module +---------------------------- + +.. automodule:: PIL.MspImagePlugin + :members: + :undoc-members: + :show-inheritance: + +:mod:`PalmImagePlugin` Module +----------------------------- + +.. automodule:: PIL.PalmImagePlugin + :members: + :undoc-members: + :show-inheritance: + +:mod:`PcdImagePlugin` Module +---------------------------- + +.. automodule:: PIL.PcdImagePlugin + :members: + :undoc-members: + :show-inheritance: + +:mod:`PcxImagePlugin` Module +---------------------------- + +.. automodule:: PIL.PcxImagePlugin + :members: + :undoc-members: + :show-inheritance: + +:mod:`PdfImagePlugin` Module +---------------------------- + +.. automodule:: PIL.PdfImagePlugin + :members: + :undoc-members: + :show-inheritance: + +:mod:`PixarImagePlugin` Module +------------------------------ + +.. automodule:: PIL.PixarImagePlugin + :members: + :undoc-members: + :show-inheritance: + +:mod:`PngImagePlugin` Module +---------------------------- + +.. automodule:: PIL.PngImagePlugin + :members: + :undoc-members: + :show-inheritance: + +:mod:`PpmImagePlugin` Module +---------------------------- + +.. automodule:: PIL.PpmImagePlugin + :members: + :undoc-members: + :show-inheritance: + +:mod:`PsdImagePlugin` Module +---------------------------- + +.. automodule:: PIL.PsdImagePlugin + :members: + :undoc-members: + :show-inheritance: + +:mod:`SgiImagePlugin` Module +---------------------------- + +.. automodule:: PIL.SgiImagePlugin + :members: + :undoc-members: + :show-inheritance: + +:mod:`SpiderImagePlugin` Module +------------------------------- + +.. automodule:: PIL.SpiderImagePlugin + :members: + :undoc-members: + :show-inheritance: + +:mod:`SunImagePlugin` Module +---------------------------- + +.. automodule:: PIL.SunImagePlugin + :members: + :undoc-members: + :show-inheritance: + +:mod:`TgaImagePlugin` Module +---------------------------- + +.. automodule:: PIL.TgaImagePlugin + :members: + :undoc-members: + :show-inheritance: + +:mod:`TiffImagePlugin` Module +----------------------------- + +.. automodule:: PIL.TiffImagePlugin + :members: + :undoc-members: + :show-inheritance: + +:mod:`WebPImagePlugin` Module +----------------------------- + +.. automodule:: PIL.WebPImagePlugin + :members: + :undoc-members: + :show-inheritance: + +:mod:`WmfImagePlugin` Module +---------------------------- + +.. automodule:: PIL.WmfImagePlugin + :members: + :undoc-members: + :show-inheritance: + +:mod:`XVThumbImagePlugin` Module +-------------------------------- + +.. automodule:: PIL.XVThumbImagePlugin + :members: + :undoc-members: + :show-inheritance: + +:mod:`XbmImagePlugin` Module +---------------------------- + +.. automodule:: PIL.XbmImagePlugin + :members: + :undoc-members: + :show-inheritance: + +:mod:`XpmImagePlugin` Module +---------------------------- + +.. automodule:: PIL.XpmImagePlugin + :members: + :undoc-members: + :show-inheritance: