Merge pull request #2133 from Temmie3754/doc-fixes

Update docs to use pygame-ce versioning

Author: ankith26

docs/reST/c_api/version.rst

@@ -13,7 +13,7 @@ Header file: src_c/include/pygame.h
 
 Version information can be retrieved at compile-time using these macros.
 
-.. versionadded:: 1.9.5
+.. versionaddedold:: 1.9.5
 
 .. c:macro:: PG_MAJOR_VERSION
 

docs/reST/conf.py

@@ -52,9 +52,9 @@
 release = '2.3.0.dev1'
 
 # Format strings for the version directives
-versionadded_format = 'New in pygame %s'
-versionchanged_format = 'Changed in pygame %s'
-deprecated_format = 'Deprecated since pygame %s'
+versionadded_format = 'New in pygame-ce %s'
+versionchanged_format = 'Changed in pygame-ce %s'
+deprecated_format = 'Deprecated since pygame-ce %s'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.

docs/reST/ext/customversion.py

@@ -10,7 +10,7 @@
     UPDATE_VERIONLABEL_CLASSES = True
 
 
-labels = ("versionadded", "versionchanged", "deprecated", "versionextended")
+labels = ("versionadded", "versionaddedold", "versionchanged", "versionchangedold", "deprecated", "deprecatedold", "versionextended", "versionextendedold")
 
 
 def set_version_formats(app, config):
@@ -20,12 +20,26 @@ def set_version_formats(app, config):
 
 def setup(app):
     app.add_directive("versionextended", VersionChange)
-    versionlabels["versionextended"] = "Extended in pygame %s"
+    app.add_directive("versionaddedold", VersionChange)
+    app.add_directive("versionchangedold", VersionChange)
+    app.add_directive("deprecatedold", VersionChange)
+    app.add_directive("versionextendedold", VersionChange)
+
+    versionlabels["versionextended"] = "Extended in pygame-ce %s"
+    versionlabels["versionaddedold"] = "New in pygame %s"
+    versionlabels["versionchangedold"] = "Changed in pygame %s"
+    versionlabels["deprecatedold"] = "Deprecated since pygame %s"
+    versionlabels["versionextendedold"] = "Extended in pygame %s"
+
 
     if UPDATE_VERIONLABEL_CLASSES:
         versionlabel_classes["versionextended"] = "extended"
+        versionlabel_classes["versionaddedold"] = "added"
+        versionlabel_classes["versionchangedold"] = "changed"
+        versionlabel_classes["deprecatedold"] = "deprecated"
+        versionlabel_classes["versionextendedold"] = "extended"
 
-    for label in ("versionadded", "versionchanged", "deprecated", "versionextended"):
+    for label in labels:
         app.add_config_value(
             f"{label}_format", str(versionlabels[label]), "env"
         )

docs/reST/ref/bufferproxy.rst

@@ -69,8 +69,8 @@
    The BufferProxy class supports subclassing, instance variables, and weak
    references.
 
-   .. versionadded:: 1.8.0
-   .. versionextended:: 1.9.2
+   .. versionaddedold:: 1.8.0
+   .. versionextendedold:: 1.9.2
 
    .. attribute:: parent
 

docs/reST/ref/camera.rst

@@ -11,8 +11,8 @@
 Pygame currently supports Linux (V4L2) and Windows (MSMF) cameras natively,
 with wider platform support available via an integrated OpenCV backend.
 
-.. versionadded:: 2.0.2 Windows native camera support
-.. versionadded:: 2.0.3 New OpenCV backends
+.. versionaddedold:: 2.0.2 Windows native camera support
+.. versionaddedold:: 2.0.3 New OpenCV backends
 
 EXPERIMENTAL!: This API may change or disappear in later pygame releases. If
 you use this, your code will very likely break with the next pygame release.
@@ -43,7 +43,7 @@ The Bayer to ``RGB`` function is based on:
  OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  SUCH DAMAGE.
 
-New in pygame 1.9.0.
+.. versionaddedold:: 1.9.0
 
 .. function:: init
 
@@ -57,7 +57,7 @@ New in pygame 1.9.0.
    want into this function. More about backends in
    :func:`get_backends()`.
 
-   .. versionchanged:: 2.0.3 Option to explicitly select backend
+   .. versionchangedold:: 2.0.3 Option to explicitly select backend
 
    .. ## pygame.camera.init ##
 
@@ -94,7 +94,7 @@ New in pygame 1.9.0.
    system, these backend ports will pass through a "camera index number" 
    through if you use that as the ``device`` parameter.
 
-   .. versionadded:: 2.0.3
+   .. versionaddedold:: 2.0.3
 
    .. ## pygame.camera.get_backends ##
 

docs/reST/ref/color.rst

@@ -92,12 +92,12 @@
    :returns: a newly created :class:`Color` object
    :rtype: Color
 
-   .. versionchanged:: 2.0.0
+   .. versionchangedold:: 2.0.0
       Support for tuples, lists, and :class:`Color` objects when creating
       :class:`Color` objects.
-   .. versionchanged:: 1.9.2 Color objects export the C level array interface.
-   .. versionchanged:: 1.9.0 Color objects support 4-element tuples of integers.
-   .. versionchanged:: 1.8.1 New implementation of the class.
+   .. versionchangedold:: 1.9.2 Color objects export the C level array interface.
+   .. versionchangedold:: 1.9.0 Color objects support 4-element tuples of integers.
+   .. versionchangedold:: 1.8.1 New implementation of the class.
 
    .. attribute:: r
 
@@ -229,7 +229,7 @@
       get the length of a Color do ``len(acolor)``.
 
       .. deprecated:: 2.1.3
-      .. versionadded:: 1.9.0
+      .. versionaddedold:: 1.9.0
 
       .. ## Color.set_length ##
 
@@ -256,7 +256,7 @@
       It must be a value between 0 and 1 where 0 means self and 1 means
       other will be returned.
 
-      .. versionadded:: 2.0.1
+      .. versionaddedold:: 2.0.1
 
       .. ## Color.lerp ##
 
@@ -273,7 +273,7 @@
       flag for :meth:`pygame.Surface.blit()`, which assumes that all surfaces using
       it are using pre-multiplied alpha colors.
 
-      .. versionadded:: 2.0.0
+      .. versionaddedold:: 2.0.0
 
       .. ## Color.premul_alpha ##
 
@@ -287,7 +287,7 @@
       Sets the elements of the color. See parameters for :meth:`pygame.Color` for the
       parameters of this function. If the alpha value was not set it will not change.
 
-      .. versionadded:: 2.0.1
+      .. versionaddedold:: 2.0.1
 
       .. ## Color.update ##
    .. ## pygame.Color ##

docs/reST/ref/cursors.rst

@@ -240,7 +240,7 @@ The following strings can be converted into cursor bitmaps with
 
    .. ## pygame.cursors.Cursor.data ##
 
-   .. versionadded:: 2.0.1
+   .. versionaddedold:: 2.0.1
 
    .. ## pygame.cursors.Cursor ##
    

docs/reST/ref/display.rst

@@ -201,7 +201,7 @@ required).
         window_surface = pygame.display.set_mode((1920, 1080), flags)
         vsync_success=False
 
-   .. versionadded:: 2.0.0 ``vsync`` parameter
+   .. versionaddedold:: 2.0.0 ``vsync`` parameter
 
    .. versionchanged:: 2.2.0 passing ``vsync`` can raise an exception
 
@@ -224,7 +224,7 @@ required).
    environment variable.
 
 
-   .. versionchanged:: 1.9.5 ``display`` argument added
+   .. versionchangedold:: 1.9.5 ``display`` argument added
 
    .. versionchanged:: 2.1.3
       pygame now ensures that subsequent calls to this function clears the
@@ -342,7 +342,7 @@ required).
    an empty dictionary will be returned. Most platforms will return a "window"
    key with the value set to the system id for the current display.
 
-   .. versionadded:: 1.7.1
+   .. versionaddedold:: 1.7.1
 
    .. ## pygame.display.get_wm_info ##
 
@@ -364,7 +364,7 @@ required).
    mode, this function *should* be used to replace many use cases of
    ``pygame.display.list_modes()`` whenever applicable.
 
-   .. versionadded:: 2.0.0
+   .. versionaddedold:: 2.0.0
 
 .. function:: list_modes
 
@@ -398,7 +398,7 @@ required).
    physical monitor resolution unless the user explicitly requests a different
    one (e.g. in an options menu or configuration file).
 
-   .. versionchanged:: 1.9.5 ``display`` argument added
+   .. versionchangedold:: 1.9.5 ``display`` argument added
 
    .. ## pygame.display.list_modes ##
 
@@ -420,7 +420,7 @@ required).
 
    The display index ``0`` means the default display is used.
 
-   .. versionchanged:: 1.9.5 ``display`` argument added
+   .. versionchangedold:: 1.9.5 ``display`` argument added
 
    .. ## pygame.display.mode_ok ##
 
@@ -484,7 +484,7 @@ required).
 
      Minimum bit size of the frame buffer. Defaults to 0.
 
-   .. versionadded:: 2.0.0 Additional attributes:
+   .. versionaddedold:: 2.0.0 Additional attributes:
 
    ::
 
@@ -683,7 +683,7 @@ required).
    Returns the number of available displays. This is always 1 if
    :func:`pygame.get_sdl_version()` returns a major version number below 2.
 
-   .. versionadded:: 1.9.5
+   .. versionaddedold:: 1.9.5
 
    .. ## pygame.display.get_num_displays ##
 
@@ -695,7 +695,7 @@ required).
    Returns the size of the window initialized with :func:`pygame.display.set_mode()`.
    This may differ from the size of the display surface if ``SCALED`` is used.
 
-   .. versionadded:: 2.0.0
+   .. versionaddedold:: 2.0.0
 
    .. ## pygame.display.get_window_size ##
 
@@ -713,7 +713,7 @@ required).
              :func:`pygame.display.set_allow_screensaver()` for
              caveats with screensaver support.
 
-   .. versionadded:: 2.0.0
+   .. versionaddedold:: 2.0.0
 
    .. ## pygame.display.get_allow_screensaver ##
 
@@ -742,7 +742,7 @@ required).
              ``SDL_HINT_VIDEO_ALLOW_SCREENSAVER`` is available in SDL 2.0.2 or later.
              SDL1.2 does not implement this.
 
-   .. versionadded:: 2.0.0
+   .. versionaddedold:: 2.0.0
 
 .. function:: is_vsync
 

docs/reST/ref/draw.rst

@@ -64,7 +64,7 @@ object around the draw calls (see :func:`pygame.Surface.lock` and
          | if ``width < 0``, nothing will be drawn
          |
       
-      .. versionchanged:: 2.1.1 
+      .. versionchangedold:: 2.1.1
           Drawing rects with width now draws the width correctly inside the 
           rect's area, rather than using an internal call to draw.lines(), 
           which had half the width spill outside the rect area.
@@ -95,8 +95,8 @@ object around the draw calls (see :func:`pygame.Surface.lock` and
       The :func:`pygame.Surface.fill()` method works just as well for drawing
       filled rectangles and can be hardware accelerated on some platforms.
 
-   .. versionchanged:: 2.0.0 Added support for keyword arguments.
-   .. versionchanged:: 2.0.0.dev8 Added support for border radius.
+   .. versionchangedold:: 2.0.0 Added support for keyword arguments.
+   .. versionchangedold:: 2.0.0.dev8 Added support for border radius.
 
    .. ## pygame.draw.rect ##
 
@@ -144,7 +144,7 @@ object around the draw calls (see :func:`pygame.Surface.lock` and
    .. note::
        For an aapolygon, use :func:`aalines()` with ``closed=True``.
 
-   .. versionchanged:: 2.0.0 Added support for keyword arguments.
+   .. versionchangedold:: 2.0.0 Added support for keyword arguments.
 
    .. ## pygame.draw.polygon ##
 
@@ -198,12 +198,12 @@ object around the draw calls (see :func:`pygame.Surface.lock` and
    :raises TypeError: if ``center`` is not a sequence of two numbers
    :raises TypeError: if ``radius`` is not a number
 
-   .. versionchanged:: 2.0.0 Added support for keyword arguments.
+   .. versionchangedold:: 2.0.0 Added support for keyword arguments.
       Nothing is drawn when the radius is 0 (a pixel at the ``center`` coordinates
       used to be drawn when the radius equaled 0).
       Floats, and Vector2 are accepted for the ``center`` param.
       The drawing algorithm was improved to look more like a circle.
-   .. versionchanged:: 2.0.0.dev8 Added support for drawing circle quadrants.
+   .. versionchangedold:: 2.0.0.dev8 Added support for drawing circle quadrants.
 
    .. ## pygame.draw.circle ##
 
@@ -240,7 +240,7 @@ object around the draw calls (see :func:`pygame.Surface.lock` and
       parameter and its width and height will be 0
    :rtype: Rect
 
-   .. versionchanged:: 2.0.0 Added support for keyword arguments.
+   .. versionchangedold:: 2.0.0 Added support for keyword arguments.
 
    .. ## pygame.draw.ellipse ##
 
@@ -293,7 +293,7 @@ object around the draw calls (see :func:`pygame.Surface.lock` and
       parameter and its width and height will be 0
    :rtype: Rect
 
-   .. versionchanged:: 2.0.0 Added support for keyword arguments.
+   .. versionchangedold:: 2.0.0 Added support for keyword arguments.
 
    .. ## pygame.draw.arc ##
 
@@ -344,7 +344,7 @@ object around the draw calls (see :func:`pygame.Surface.lock` and
    :raises TypeError: if ``start_pos`` or ``end_pos`` is not a sequence of
       two numbers
 
-   .. versionchanged:: 2.0.0 Added support for keyword arguments.
+   .. versionchangedold:: 2.0.0 Added support for keyword arguments.
 
    .. ## pygame.draw.line ##
 
@@ -393,7 +393,7 @@ object around the draw calls (see :func:`pygame.Surface.lock` and
    :raises TypeError: if ``points`` is not a sequence or ``points`` does not
       contain number pairs
 
-   .. versionchanged:: 2.0.0 Added support for keyword arguments.
+   .. versionchangedold:: 2.0.0 Added support for keyword arguments.
 
    .. ## pygame.draw.lines ##
 
@@ -500,7 +500,7 @@ object around the draw calls (see :func:`pygame.Surface.lock` and
    :raises TypeError: if ``start_pos`` or ``end_pos`` is not a sequence of
       two numbers
 
-   .. versionchanged:: 2.0.0 Added support for keyword arguments.
+   .. versionchangedold:: 2.0.0 Added support for keyword arguments.
 
    .. ## pygame.draw.aaline ##
 
@@ -542,7 +542,7 @@ object around the draw calls (see :func:`pygame.Surface.lock` and
    :raises TypeError: if ``points`` is not a sequence or ``points`` does not
       contain number pairs
 
-   .. versionchanged:: 2.0.0 Added support for keyword arguments.
+   .. versionchangedold:: 2.0.0 Added support for keyword arguments.
 
    .. ## pygame.draw.aalines ##