New website style + docs sorting modifications

docs/README.md

@@ -14,6 +14,10 @@ Steps:
 - If you are using the legacy `python setup.py docs` (which is now deprecated):
      - (Run `python -m pip install -U pip setuptools` first if `ModuleNotFoundError: No module named setuptools` occurs)
 
+You may want to test the new website style, you just have to edit
+``docs/reST/conf.py`` and change the value of ``html_theme`` to ``sphinx_book_theme``.
+(Make sure before to install the theme with ``python -m pip install sphinx_book_theme``)
+
 This will create a new folder under the `docs` folder. 
 In `docs/generated`, you will find a local copy of the pygame documentation.
 

docs/reST/conf.py

@@ -104,6 +104,7 @@
 # The theme to use for HTML and HTML Help pages.  Major themes that come with
 # Sphinx are currently 'default' and 'sphinxdoc'.
 html_theme = 'classic'
+# html_theme = 'sphinx_book_theme'
 
 # Theme options are theme-specific and customize the look and feel of a theme
 # further.  For a list of options available for each theme, see the

docs/reST/index.rst

@@ -6,11 +6,8 @@ Pygame-ce Front Page
    :glob:
    :hidden:
 
-   ref/*
-   tutorials/en/*
-   tutorials/en/**/*
-   tutorials/ko/**/*
-   tutorials/es/*
+   modules
+   tutorials
    c_api
    filepaths
    logos

docs/reST/modules.rst

@@ -0,0 +1,98 @@
+Pygame modules
+==============
+
+*************************************************
+  List of pygame modules
+*************************************************
+
+.. toctree::
+   :maxdepth: 2
+   :glob:
+   :hidden:
+
+   ref/pygame.rst
+   ref/*
+
+:doc:`ref/bufferproxy`
+  An array protocol view of surface pixels
+
+:doc:`ref/color`
+  Color representation.
+
+:doc:`ref/cursors`
+  Loading and compiling cursor images.
+
+:doc:`ref/display`
+  Configure the display surface.
+
+:doc:`ref/draw`
+  Drawing simple shapes like lines and ellipses to surfaces.
+
+:doc:`ref/event`
+  Manage the incoming events from various input devices and the windowing platform.
+
+:doc:`ref/examples`
+  Various programs demonstrating the use of individual pygame modules.
+
+:doc:`ref/font`
+  Loading and rendering TrueType fonts.
+
+:doc:`ref/freetype`
+  Enhanced pygame module for loading and rendering font faces.
+
+:doc:`ref/gfxdraw`
+  Anti-aliasing draw functions.
+
+:doc:`ref/image`
+  Loading, saving, and transferring of surfaces.
+
+:doc:`ref/joystick`
+  Manage the joystick devices.
+
+:doc:`ref/key`
+  Manage the keyboard device.
+
+:doc:`ref/locals`
+  Pygame constants.
+
+:doc:`ref/mixer`
+  Load and play sounds
+
+:doc:`ref/mouse`
+  Manage the mouse device and display.
+
+:doc:`ref/music`
+  Play streaming music tracks.
+
+:doc:`ref/pygame`
+  Top level functions to manage pygame.
+
+:doc:`ref/pixelarray`
+  Manipulate image pixel data.
+
+:doc:`ref/rect`
+  Flexible container for a rectangle.
+
+:doc:`ref/scrap`
+  Native clipboard access.
+
+:doc:`ref/sndarray`
+  Manipulate sound sample data.
+
+:doc:`ref/sprite`
+  Higher level objects to represent game images.
+
+:doc:`ref/surface`
+  Objects for images and the screen.
+
+:doc:`ref/surfarray`
+  Manipulate image pixel data.
+
+:doc:`ref/tests`
+  Test pygame.
+
+:doc:`ref/time`
+  Manage timing and framerate.
+
+:doc:`ref/transform`
+  Resize and move images.

docs/reST/ref/color.rst

@@ -3,6 +3,13 @@
 :mod:`pygame.Color`
 ===================
 
+.. toctree::
+   :maxdepth: 2
+   :glob:
+   :hidden:
+
+   extra_infos/color_list.rst
+
 .. currentmodule:: pygame
 
 .. class:: Color
@@ -53,7 +60,7 @@
    It can be passed as a ``color_value`` argument to :class:`Color`
    (useful with sets).
 
-   See :doc:`color_list` for samples of the available named colors.
+   See :doc:`extra_infos/color_list` for samples of the available named colors.
 
    :param int r: red value in the range of 0 to 255 inclusive
    :param int g: green value in the range of 0 to 255 inclusive
@@ -67,7 +74,7 @@
             | - **Color object:** clones the given :class:`Color` object
             | - **Color name: str:** name of the color to use, e.g. ``'red'``
               (all the supported name strings can be found in the
-               :doc:`color_list`, with sample swatches)
+               :doc:`extra_infos/color_list`, with sample swatches)
             | - **HTML color format str:** ``'#rrggbbaa'`` or ``'#rrggbb'``,
               where rr, gg, bb, and aa are 2-digit hex numbers in the range
               of 0 to 0xFF inclusive, the aa (alpha) value defaults to 0xFF

docs/reST/ref/draw.rst

@@ -52,7 +52,7 @@ object around the draw calls (see :func:`pygame.Surface.lock` and
    :param Surface surface: surface to draw on
    :param color: color to draw with, the alpha value is optional if using a
       tuple ``(RGB[A])``
-   :type color: Color or string (for :doc:`color_list`) or int or tuple(int, int, int, [int])
+   :type color: Color or string (for :doc:`extra_infos/color_list`) or int or tuple(int, int, int, [int])
    :param Rect rect: rectangle to draw, position and dimensions
    :param int width: (optional) used for line thickness or to indicate that
       the rectangle is to be filled (not to be confused with the width value
@@ -110,7 +110,7 @@ object around the draw calls (see :func:`pygame.Surface.lock` and
    :param Surface surface: surface to draw on
    :param color: color to draw with, the alpha value is optional if using a
       tuple ``(RGB[A])``
-   :type color: Color or string (for :doc:`color_list`) or int or tuple(int, int, int, [int])
+   :type color: Color or string (for :doc:`extra_infos/color_list`) or int or tuple(int, int, int, [int])
    :param points: a sequence of 3 or more (x, y) coordinates that make up the
       vertices of the polygon, each *coordinate* in the sequence must be a
       tuple/list/:class:`pygame.math.Vector2` of 2 ints/floats,
@@ -158,7 +158,7 @@ object around the draw calls (see :func:`pygame.Surface.lock` and
    :param Surface surface: surface to draw on
    :param color: color to draw with, the alpha value is optional if using a
       tuple ``(RGB[A])``
-   :type color: Color or string (for :doc:`color_list`) or int or tuple(int, int, int, [int])
+   :type color: Color or string (for :doc:`extra_infos/color_list`) or int or tuple(int, int, int, [int])
    :param center: center point of the circle as a sequence of 2 ints/floats,
       e.g. ``(x, y)``
    :type center: tuple(int or float, int or float) or
@@ -219,7 +219,7 @@ object around the draw calls (see :func:`pygame.Surface.lock` and
    :param Surface surface: surface to draw on
    :param color: color to draw with, the alpha value is optional if using a
       tuple ``(RGB[A])``
-   :type color: Color or string (for :doc:`color_list`) or int or tuple(int, int, int, [int])
+   :type color: Color or string (for :doc:`extra_infos/color_list`) or int or tuple(int, int, int, [int])
    :param center: center point of the circle as a sequence of 2 ints/floats,
       e.g. ``(x, y)``
    :type center: tuple(int or float, int or float) or
@@ -273,7 +273,7 @@ object around the draw calls (see :func:`pygame.Surface.lock` and
    :param Surface surface: surface to draw on
    :param color: color to draw with, the alpha value is optional if using a
       tuple ``(RGB[A])``
-   :type color: Color or string (for :doc:`color_list`) or int or tuple(int, int, int, [int])
+   :type color: Color or string (for :doc:`extra_infos/color_list`) or int or tuple(int, int, int, [int])
    :param Rect rect: rectangle to indicate the position and dimensions of the
       ellipse, the ellipse will be centered inside the rectangle and bounded
       by it
@@ -314,7 +314,7 @@ object around the draw calls (see :func:`pygame.Surface.lock` and
    :param Surface surface: surface to draw on
    :param color: color to draw with, the alpha value is optional if using a
       tuple ``(RGB[A])``
-   :type color: Color or string (for :doc:`color_list`) or int or tuple(int, int, int, [int])
+   :type color: Color or string (for :doc:`extra_infos/color_list`) or int or tuple(int, int, int, [int])
    :param Rect rect: rectangle to indicate the position and dimensions of the
       ellipse which the arc will be based on, the ellipse will be centered
       inside the rectangle
@@ -364,7 +364,7 @@ object around the draw calls (see :func:`pygame.Surface.lock` and
    :param Surface surface: surface to draw on
    :param color: color to draw with, the alpha value is optional if using a
       tuple ``(RGB[A])``
-   :type color: Color or string (for :doc:`color_list`) or int or tuple(int, int, int, [int])
+   :type color: Color or string (for :doc:`extra_infos/color_list`) or int or tuple(int, int, int, [int])
    :param start_pos: start position of the line, (x, y)
    :type start_pos: tuple(int or float, int or float) or
       list(int or float, int or float) or Vector2(int or float, int or float)
@@ -416,7 +416,7 @@ object around the draw calls (see :func:`pygame.Surface.lock` and
    :param Surface surface: surface to draw on
    :param color: color to draw with, the alpha value is optional if using a
       tuple ``(RGB[A])``
-   :type color: Color or string (for :doc:`color_list`) or int or tuple(int, int, int, [int])
+   :type color: Color or string (for :doc:`extra_infos/color_list`) or int or tuple(int, int, int, [int])
    :param bool closed: if ``True`` an additional line segment is drawn between
       the first and last points in the ``points`` sequence
    :param points: a sequence of 2 or more (x, y) coordinates, where each
@@ -536,7 +536,7 @@ object around the draw calls (see :func:`pygame.Surface.lock` and
    :param Surface surface: surface to draw on
    :param color: color to draw with, the alpha value is optional if using a
       tuple ``(RGB[A])``
-   :type color: Color or string (for :doc:`color_list`) or int or tuple(int, int, int, [int])
+   :type color: Color or string (for :doc:`extra_infos/color_list`) or int or tuple(int, int, int, [int])
    :param start_pos: start position of the line, (x, y)
    :type start_pos: tuple(int or float, int or float) or
       list(int or float, int or float) or Vector2(int or float, int or float)
@@ -569,7 +569,7 @@ object around the draw calls (see :func:`pygame.Surface.lock` and
    :param Surface surface: surface to draw on
    :param color: color to draw with, the alpha value is optional if using a
       tuple ``(RGB[A])``
-   :type color: Color or string (for :doc:`color_list`) or int or tuple(int, int, int, [int])
+   :type color: Color or string (for :doc:`extra_infos/color_list`) or int or tuple(int, int, int, [int])
    :param bool closed: if ``True`` an additional line segment is drawn between
       the first and last points in the ``points`` sequence
    :param points: a sequence of 2 or more (x, y) coordinates, where each

docs/reST/ref/color_list.rst → docs/reST/ref/extra_infos/color_list.rst

@@ -1,4 +1,4 @@
-.. include:: common.txt
+.. include:: ../../common.txt
 
 Named Colors
 ============
@@ -673,7 +673,7 @@ Named Colors
     .yellowgreen {background-color: #9acd32; color: #9acd32;}
     </style>
 
-:doc:`color` lets you specify any of these named colors when creating a new
+:doc:`../color` lets you specify any of these named colors when creating a new
 ``pygame.Color`` (taken from the
 `colordict module <https://github.com/pygame-community/pygame-ce/blob/main/src_py/colordict.py>`_).