Merge pull request #2853 from pygame-community/ankith26-use-makeref

zoldalma999 · web-flow · commit 17f57ef42752 · 2024-05-25T14:32:20.000+02:00
Deprecate `setup.py docs`, make docs in meson build
diff --git a/.circleci/config.yml b/.circleci/config.yml
@@ -34,7 +34,6 @@ jobs:
       - CIBW_SKIP: '*-musllinux_*'
       - CIBW_MANYLINUX_AARCH64_IMAGE: manylinux2014_base_aarch64
       - CIBW_MANYLINUX_PYPY_AARCH64_IMAGE: manylinux2014_base_aarch64
-      - CIBW_BEFORE_BUILD: pip install Sphinx"<7.2.0" && python setup.py docs
       - CIBW_TEST_COMMAND: python -m pygame.tests -v --exclude opengl,music,timing --time_out 300
       - CIBW_BUILD_VERBOSITY: 2
 
diff --git a/.github/workflows/build-debian-multiarch.yml b/.github/workflows/build-debian-multiarch.yml
@@ -100,7 +100,6 @@ jobs:
         # (done for optimization reasons)
         run: |
           echo "\nBuilding pygame wheel\n"
-          python3 setup.py docs
           pip3 wheel . --no-build-isolation --wheel-dir /artifacts -vvv
           echo "\nInstalling wheel\n"
           pip3 install --no-index --pre --break-system-packages --find-links /artifacts pygame-ce
diff --git a/.github/workflows/build-macos.yml b/.github/workflows/build-macos.yml
@@ -152,8 +152,7 @@ jobs:
         bash ./install_mac_deps.sh
 
       CIBW_BEFORE_BUILD: |
-        pip install numpy Sphinx"<7.2.0"
-        python setup.py docs
+        pip install numpy
         cp -r ${{ github.workspace }}/pygame_mac_deps_${{ matrix.macarch }} ${{ github.workspace }}/pygame_mac_deps
 
       # To remove any speculations about the wheel not being self-contained
diff --git a/.github/workflows/build-manylinux.yml b/.github/workflows/build-manylinux.yml
@@ -60,11 +60,6 @@ jobs:
       # skip musllinux for now
       CIBW_SKIP: '*-musllinux_*'
 
-      # command that runs before every build
-      CIBW_BEFORE_BUILD: |
-        pip install Sphinx"<7.2.0"
-        python setup.py docs
-
       CIBW_TEST_COMMAND: python -m pygame.tests -v --exclude opengl,music,timing --time_out 300
 
       # To 'solve' this issue:
diff --git a/.github/workflows/build-on-msys2.yml b/.github/workflows/build-on-msys2.yml
@@ -72,7 +72,6 @@ jobs:
 
       - name: Building pygame wheel
         run: |
-          python3 setup.py docs
           pip3 wheel . --wheel-dir /artifacts -vvv --no-build-isolation
 
       - name: Installing wheel
diff --git a/.github/workflows/build-ubuntu-sdist.yml b/.github/workflows/build-ubuntu-sdist.yml
@@ -66,7 +66,7 @@ jobs:
 
     - name: Make sdist and install it
       run: |
-        python3 setup.py docs
+        python3 buildconfig/make_docs.py
         python3 setup.py sdist
         pip3 install dist/pygame-*.tar.gz -vv
 
diff --git a/.github/workflows/build-windows.yml b/.github/workflows/build-windows.yml
@@ -132,7 +132,7 @@ jobs:
       CIBW_BUILD: ${{ matrix.pyversions }}
       CIBW_ARCHS: ${{ matrix.winarch }}
 
-      CIBW_BEFORE_BUILD: pip install numpy Sphinx"<7.2.0" && python setup.py docs
+      CIBW_BEFORE_BUILD: pip install numpy
 
       CIBW_TEST_COMMAND: python -m pygame.tests -v --exclude opengl,timing --time_out 300
 
diff --git a/.github/workflows/format-lint.yml b/.github/workflows/format-lint.yml
@@ -50,10 +50,10 @@ jobs:
 
       - name: Check docs changes are checked in
         run: |
-          python3 setup.py docs
+          python3 buildconfig/make_docs.py
           if [[ `git status --porcelain` ]]; then
             echo "Generating docs caused changes. Please check them in."
-            echo "You may need to run: python3 setup.py docs --fullgeneration"
+            echo "You may need to run: python3 buildconfig/make_docs.py full_generation"
             # Run git status again, so people can see what changed.
             git status --porcelain
             exit 1
diff --git a/.gitignore b/.gitignore
@@ -11,7 +11,7 @@
 # macOS generated files
 .DS_Store
 
-# Sphinx generated files: makeref.py
+# Sphinx generated files: make_docs.py
 /docs/generated
 
 # Emacs temporary files
diff --git a/buildconfig/make_docs.py b/buildconfig/make_docs.py
diff --git a/buildconfig/manylinux-build/build-wheels.sh b/buildconfig/manylinux-build/build-wheels.sh
@@ -42,7 +42,7 @@ for PYVER in $SUPPORTED_PYTHONS; do
 
     ${PYTHON} -m pip install Sphinx
     cd io
-    ${PYTHON} setup.py docs
+    ${PYTHON} buildconfig/make_docs.py
     cd ..
     ${PYTHON} -m pip wheel --global-option="build_ext" --global-option="-j4" -vvv /io/ -w wheelhouse/
 done
diff --git a/docs/README.md b/docs/README.md
@@ -10,7 +10,8 @@ but the documentation can also be launched with `python -m pygame.docs`
 Steps:
 - Install Sphinx (`pip install Sphinx`)
 - Fork the pygame-ce repository, download and navigate to it in the terminal
-- Run `python setup.py docs`
+- Run `python buildconfig/make_docs.py`
+- 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)
 
 This will create a new folder under the `docs` folder. 
diff --git a/docs/meson.build b/docs/meson.build
@@ -14,6 +14,8 @@ if fs.is_dir('generated')
     )
 elif get_option('error_docs_missing')
     error('The "generated" docs folder does not exist!')
+else
+    warning('The "generated" docs folder does not exist!')
 endif
 
 docs_files = files('__init__.py', '__main__.py', 'serve.py', 'static.py')
diff --git a/docs/reST/_templates/header.h b/docs/reST/_templates/header.h
@@ -17,7 +17,7 @@
 {#- -#}
 
 
-/* Auto generated file: with makeref.py .  Docs go in docs/reST/ref/ . */
+/* Auto generated file: with make_docs.py .  Docs go in docs/reST/ref/ . */
 {% for item in hdr_items -%}
 #define {{ cmacro(item) }} "{{ join_sigs(item) }}{{ item['summary'] }}"
 {% endfor %}
diff --git a/meson.build b/meson.build
@@ -364,6 +364,16 @@ subdir('src_c')
 subdir('src_py')
 
 if not get_option('stripped')
+    # run make_docs and make docs
+    if not fs.is_dir('generated')
+        make_docs = files('buildconfig/make_docs.py')
+        res = run_command(
+            [find_program('python3', 'python'), make_docs],
+            check: false,
+        )
+        message(res.stdout().strip())
+        message(res.stderr().strip())
+    endif
     subdir('docs')
     subdir('test')
     subdir('buildconfig/stubs')
diff --git a/pyproject.toml b/pyproject.toml
@@ -48,7 +48,7 @@ classifiers = [
 hook-dirs = 'pygame.__pyinstaller:get_hook_dirs'
 
 [build-system]
-requires = ["meson-python", "ninja", "cython"]
+requires = ["meson-python", "ninja", "cython", "sphinx<=7.2.6"]
 build-backend = 'mesonpy'
 
 [tool.meson-python.args]
diff --git a/setup.py b/setup.py
@@ -802,12 +802,14 @@ def run(self):
         runs Sphinx to build the docs.
         '''
         import subprocess
-        print("Using python:", sys.executable)
         command_line = [
-            sys.executable, os.path.join('buildconfig', 'makeref.py')
+            sys.executable, os.path.join('buildconfig', 'make_docs.py')
         ]
         if self.fullgeneration:
             command_line.append('full_generation')
+
+        print("WARNING: This command is deprecated and will be removed in the future.")
+        print(f"Please use the following replacement: `{' '.join(command_line)}`\n")  
         if subprocess.call(command_line) != 0:
             raise SystemExit("Failed to build documentation")
 
diff --git a/src_c/doc/README.rst b/src_c/doc/README.rst
@@ -2,4 +2,4 @@ These files are generated from the rst files in docs/reST/ref/
 
 Both the .rst file and the generated .h file should be committed.
 
-To generate docs run: python setup.py docs
+To generate docs run: `python buildconfig/make_docs.py`.
diff --git a/src_c/doc/bufferproxy_doc.h b/src_c/doc/bufferproxy_doc.h
@@ -1,4 +1,4 @@
-/* Auto generated file: with makeref.py .  Docs go in docs/reST/ref/ . */
+/* Auto generated file: with make_docs.py .  Docs go in docs/reST/ref/ . */
 #define DOC_BUFFERPROXY "BufferProxy(<parent>) -> BufferProxy\npygame object to export a surface buffer through an array protocol"
 #define DOC_BUFFERPROXY_PARENT "parent -> Surface\nparent -> <parent>\nReturn wrapped exporting object."
 #define DOC_BUFFERPROXY_LENGTH "length -> int\nThe size, in bytes, of the exported buffer."
diff --git a/src_c/doc/camera_doc.h b/src_c/doc/camera_doc.h
@@ -1,4 +1,4 @@
-/* Auto generated file: with makeref.py .  Docs go in docs/reST/ref/ . */
+/* Auto generated file: with make_docs.py .  Docs go in docs/reST/ref/ . */
 #define DOC_CAMERA "pygame module for camera use"
 #define DOC_CAMERA_INIT "init(backend = None) -> None\nModule init"
 #define DOC_CAMERA_GETBACKENDS "get_backends() -> [str]\nGet the backends supported on this system"
diff --git a/src_c/doc/color_doc.h b/src_c/doc/color_doc.h
@@ -1,4 +1,4 @@
-/* Auto generated file: with makeref.py .  Docs go in docs/reST/ref/ . */
+/* Auto generated file: with make_docs.py .  Docs go in docs/reST/ref/ . */
 #define DOC_COLOR "Color(r, g, b) -> Color\nColor(r, g, b, a=255) -> Color\nColor(color_value) -> Color\npygame object for color representations"
 #define DOC_COLOR_R "r -> int\nGets or sets the red value of the Color."
 #define DOC_COLOR_G "g -> int\nGets or sets the green value of the Color."
diff --git a/src_c/doc/cursors_doc.h b/src_c/doc/cursors_doc.h
@@ -1,4 +1,4 @@
-/* Auto generated file: with makeref.py .  Docs go in docs/reST/ref/ . */
+/* Auto generated file: with make_docs.py .  Docs go in docs/reST/ref/ . */
 #define DOC_CURSORS "pygame module for cursor resources"
 #define DOC_CURSORS_COMPILE "compile(strings, black='X', white='.', xor='o') -> data, mask\ncreate binary cursor data from simple strings"
 #define DOC_CURSORS_LOADXBM "load_xbm(cursorfile) -> cursor_args\nload_xbm(cursorfile, maskfile) -> cursor_args\nload cursor data from an XBM file"
diff --git a/src_c/doc/display_doc.h b/src_c/doc/display_doc.h
@@ -1,4 +1,4 @@
-/* Auto generated file: with makeref.py .  Docs go in docs/reST/ref/ . */
+/* Auto generated file: with make_docs.py .  Docs go in docs/reST/ref/ . */
 #define DOC_DISPLAY "pygame module to control the display window and screen"
 #define DOC_DISPLAY_INIT "init() -> None\nInitialize the display module"
 #define DOC_DISPLAY_QUIT "quit() -> None\nUninitialize the display module"
diff --git a/src_c/doc/draw_doc.h b/src_c/doc/draw_doc.h
@@ -1,4 +1,4 @@
-/* Auto generated file: with makeref.py .  Docs go in docs/reST/ref/ . */
+/* Auto generated file: with make_docs.py .  Docs go in docs/reST/ref/ . */
 #define DOC_DRAW "pygame module for drawing shapes"
 #define DOC_DRAW_RECT "rect(surface, color, rect) -> Rect\nrect(surface, color, rect, width=0, border_radius=0, border_top_left_radius=-1, border_top_right_radius=-1, border_bottom_left_radius=-1, border_bottom_right_radius=-1) -> Rect\ndraw a rectangle"
 #define DOC_DRAW_POLYGON "polygon(surface, color, points) -> Rect\npolygon(surface, color, points, width=0) -> Rect\ndraw a polygon"
diff --git a/src_c/doc/event_doc.h b/src_c/doc/event_doc.h
@@ -1,4 +1,4 @@
-/* Auto generated file: with makeref.py .  Docs go in docs/reST/ref/ . */
+/* Auto generated file: with make_docs.py .  Docs go in docs/reST/ref/ . */
 #define DOC_EVENT "pygame module for interacting with events and queues"
 #define DOC_EVENT_PUMP "pump() -> None\ninternally process pygame event handlers"
 #define DOC_EVENT_GET "get(eventtype=None) -> Eventlist\nget(eventtype=None, pump=True) -> Eventlist\nget(eventtype=None, pump=True, exclude=None) -> Eventlist\nget events from the queue"
diff --git a/src_c/doc/examples_doc.h b/src_c/doc/examples_doc.h
@@ -1,4 +1,4 @@
-/* Auto generated file: with makeref.py .  Docs go in docs/reST/ref/ . */
+/* Auto generated file: with make_docs.py .  Docs go in docs/reST/ref/ . */
 #define DOC_EXAMPLES "module of example programs"
 #define DOC_EXAMPLES_ALIENS_MAIN "aliens.main() -> None\nplay the full aliens example"
 #define DOC_EXAMPLES_STARS_MAIN "stars.main() -> None\nrun a simple starfield example"
diff --git a/src_c/doc/font_doc.h b/src_c/doc/font_doc.h
@@ -1,4 +1,4 @@
-/* Auto generated file: with makeref.py .  Docs go in docs/reST/ref/ . */
+/* Auto generated file: with make_docs.py .  Docs go in docs/reST/ref/ . */
 #define DOC_FONT "pygame module for loading and rendering fonts"
 #define DOC_FONT_INIT "init() -> None\ninitialize the font module"
 #define DOC_FONT_QUIT "quit() -> None\nuninitialize the font module"
diff --git a/src_c/doc/freetype_doc.h b/src_c/doc/freetype_doc.h
@@ -1,4 +1,4 @@
-/* Auto generated file: with makeref.py .  Docs go in docs/reST/ref/ . */
+/* Auto generated file: with make_docs.py .  Docs go in docs/reST/ref/ . */
 #define DOC_FREETYPE "Enhanced pygame module for loading and rendering computer fonts"
 #define DOC_FREETYPE_GETERROR "get_error() -> str\nget_error() -> None\nReturn the latest FreeType error"
 #define DOC_FREETYPE_GETVERSION "get_version(linked=True) -> (int, int, int)\nReturn the FreeType version"
diff --git a/src_c/doc/geometry_doc.h b/src_c/doc/geometry_doc.h
@@ -1,4 +1,4 @@
-/* Auto generated file: with makeref.py .  Docs go in docs/reST/ref/ . */
+/* Auto generated file: with make_docs.py .  Docs go in docs/reST/ref/ . */
 #define DOC_GEOMETRY "pygame module for the Circle, Line, and Polygon objects"
 #define DOC_CIRCLE "Circle((x, y), radius) -> Circle\nCircle(x, y, radius) -> Circle\npygame object for representing a circle"
 #define DOC_CIRCLE_X "x -> float\ncenter x coordinate of the circle"
diff --git a/src_c/doc/gfxdraw_doc.h b/src_c/doc/gfxdraw_doc.h
@@ -1,4 +1,4 @@
-/* Auto generated file: with makeref.py .  Docs go in docs/reST/ref/ . */
+/* Auto generated file: with make_docs.py .  Docs go in docs/reST/ref/ . */
 #define DOC_GFXDRAW "pygame module for drawing shapes"
 #define DOC_GFXDRAW_PIXEL "pixel(surface, x, y, color, /) -> None\ndraw a pixel"
 #define DOC_GFXDRAW_HLINE "hline(surface, x1, x2, y, color, /) -> None\ndraw a horizontal line"
diff --git a/src_c/doc/image_doc.h b/src_c/doc/image_doc.h
@@ -1,4 +1,4 @@
-/* Auto generated file: with makeref.py .  Docs go in docs/reST/ref/ . */
+/* Auto generated file: with make_docs.py .  Docs go in docs/reST/ref/ . */
 #define DOC_IMAGE "pygame module for image transfer"
 #define DOC_IMAGE_LOAD "load(file) -> Surface\nload(file, namehint="") -> Surface\nload new image from a file (or file-like object)"
 #define DOC_IMAGE_LOADSIZEDSVG "load_sized_svg(file, size) -> Surface\nload an SVG image from a file (or file-like object) with the given size"
diff --git a/src_c/doc/joystick_doc.h b/src_c/doc/joystick_doc.h
@@ -1,4 +1,4 @@
-/* Auto generated file: with makeref.py .  Docs go in docs/reST/ref/ . */
+/* Auto generated file: with make_docs.py .  Docs go in docs/reST/ref/ . */
 #define DOC_JOYSTICK "Pygame module for interacting with joysticks, gamepads, and trackballs."
 #define DOC_JOYSTICK_INIT "init() -> None\nInitialize the joystick module."
 #define DOC_JOYSTICK_QUIT "quit() -> None\nUninitialize the joystick module."
diff --git a/src_c/doc/key_doc.h b/src_c/doc/key_doc.h
@@ -1,4 +1,4 @@
-/* Auto generated file: with makeref.py .  Docs go in docs/reST/ref/ . */
+/* Auto generated file: with make_docs.py .  Docs go in docs/reST/ref/ . */
 #define DOC_KEY "pygame module to work with the keyboard"
 #define DOC_KEY_GETFOCUSED "get_focused() -> bool\ntrue if the display is receiving keyboard input from the system"
 #define DOC_KEY_GETPRESSED "get_pressed() -> bools\nget the state of all keyboard buttons"
diff --git a/src_c/doc/locals_doc.h b/src_c/doc/locals_doc.h
@@ -1,2 +1,2 @@
-/* Auto generated file: with makeref.py .  Docs go in docs/reST/ref/ . */
+/* Auto generated file: with make_docs.py .  Docs go in docs/reST/ref/ . */
 #define DOC_LOCALS "pygame constants"
diff --git a/src_c/doc/mask_doc.h b/src_c/doc/mask_doc.h
@@ -1,4 +1,4 @@
-/* Auto generated file: with makeref.py .  Docs go in docs/reST/ref/ . */
+/* Auto generated file: with make_docs.py .  Docs go in docs/reST/ref/ . */
 #define DOC_MASK "pygame module for image masks."
 #define DOC_MASK_FROMSURFACE "from_surface(surface) -> Mask\nfrom_surface(surface, threshold=127) -> Mask\nCreates a Mask from the given surface"
 #define DOC_MASK_FROMTHRESHOLD "from_threshold(surface, color) -> Mask\nfrom_threshold(surface, color, threshold=(0, 0, 0, 255), othersurface=None, palette_colors=1) -> Mask\nCreates a mask by thresholding Surfaces"
diff --git a/src_c/doc/math_doc.h b/src_c/doc/math_doc.h
@@ -1,4 +1,4 @@
-/* Auto generated file: with makeref.py .  Docs go in docs/reST/ref/ . */
+/* Auto generated file: with make_docs.py .  Docs go in docs/reST/ref/ . */
 #define DOC_MATH "pygame module for vector classes"
 #define DOC_MATH_CLAMP "clamp(value, min, max, /) -> float\nreturns value clamped to min and max."
 #define DOC_MATH_LERP "lerp(a, b, value, do_clamp=True, /) -> float\nreturns value linearly interpolated between a and b"
diff --git a/src_c/doc/midi_doc.h b/src_c/doc/midi_doc.h
@@ -1,4 +1,4 @@
-/* Auto generated file: with makeref.py .  Docs go in docs/reST/ref/ . */
+/* Auto generated file: with make_docs.py .  Docs go in docs/reST/ref/ . */
 #define DOC_MIDI "pygame module for interacting with midi input and output."
 #define DOC_MIDI_INIT "init() -> None\ninitialize the midi module"
 #define DOC_MIDI_QUIT "quit() -> None\nuninitialize the midi module"
diff --git a/src_c/doc/mixer_doc.h b/src_c/doc/mixer_doc.h
@@ -1,4 +1,4 @@
-/* Auto generated file: with makeref.py .  Docs go in docs/reST/ref/ . */
+/* Auto generated file: with make_docs.py .  Docs go in docs/reST/ref/ . */
 #define DOC_MIXER "pygame module for loading and playing sounds"
 #define DOC_MIXER_INIT "init(frequency=44100, size=-16, channels=2, buffer=512, devicename=None, allowedchanges=AUDIO_ALLOW_FREQUENCY_CHANGE | AUDIO_ALLOW_CHANNELS_CHANGE) -> None\ninitialize the mixer module"
 #define DOC_MIXER_PREINIT "pre_init(frequency=44100, size=-16, channels=2, buffer=512, devicename=None, allowedchanges=AUDIO_ALLOW_FREQUENCY_CHANGE | AUDIO_ALLOW_CHANNELS_CHANGE) -> None\npreset the mixer init arguments"
diff --git a/src_c/doc/mouse_doc.h b/src_c/doc/mouse_doc.h
@@ -1,4 +1,4 @@
-/* Auto generated file: with makeref.py .  Docs go in docs/reST/ref/ . */
+/* Auto generated file: with make_docs.py .  Docs go in docs/reST/ref/ . */
 #define DOC_MOUSE "pygame module to work with the mouse"
 #define DOC_MOUSE_GETPRESSED "get_pressed(num_buttons=3) -> (left_button, middle_button, right_button)\nget_pressed(num_buttons=5) -> (left_button, middle_button, right_button, x1_button, x2_button)\nget the state of the mouse buttons"
 #define DOC_MOUSE_GETJUSTPRESSED "get_just_pressed() -> (left_button, middle_button, right_button, x1_button, x2_button)\nget the most recently pressed buttons"
diff --git a/src_c/doc/music_doc.h b/src_c/doc/music_doc.h
@@ -1,4 +1,4 @@
-/* Auto generated file: with makeref.py .  Docs go in docs/reST/ref/ . */
+/* Auto generated file: with make_docs.py .  Docs go in docs/reST/ref/ . */
 #define DOC_MIXER_MUSIC "pygame module for controlling streamed audio"
 #define DOC_MIXER_MUSIC_LOAD "load(filename) -> None\nload(fileobj, namehint="") -> None\nLoad a music file for playback"
 #define DOC_MIXER_MUSIC_UNLOAD "unload() -> None\nUnload the currently loaded music to free up resources"
diff --git a/src_c/doc/pixelarray_doc.h b/src_c/doc/pixelarray_doc.h
@@ -1,4 +1,4 @@
-/* Auto generated file: with makeref.py .  Docs go in docs/reST/ref/ . */
+/* Auto generated file: with make_docs.py .  Docs go in docs/reST/ref/ . */
 #define DOC_PIXELARRAY "PixelArray(Surface) -> PixelArray\npygame object for direct pixel access of surfaces"
 #define DOC_PIXELARRAY_SURFACE "surface -> Surface\nGets the Surface the PixelArray uses."
 #define DOC_PIXELARRAY_ITEMSIZE "itemsize -> int\nReturns the byte size of a pixel array item"
diff --git a/src_c/doc/pixelcopy_doc.h b/src_c/doc/pixelcopy_doc.h
@@ -1,4 +1,4 @@
-/* Auto generated file: with makeref.py .  Docs go in docs/reST/ref/ . */
+/* Auto generated file: with make_docs.py .  Docs go in docs/reST/ref/ . */
 #define DOC_PIXELCOPY "pygame module for general pixel array copying"
 #define DOC_PIXELCOPY_SURFACETOARRAY "surface_to_array(array, surface, kind='P', opaque=255, clear=0) -> None\ncopy surface pixels to an array object"
 #define DOC_PIXELCOPY_ARRAYTOSURFACE "array_to_surface(surface, array, /) -> None\ncopy an array object to a surface"
diff --git a/src_c/doc/pygame_doc.h b/src_c/doc/pygame_doc.h
@@ -1,4 +1,4 @@
-/* Auto generated file: with makeref.py .  Docs go in docs/reST/ref/ . */
+/* Auto generated file: with make_docs.py .  Docs go in docs/reST/ref/ . */
 #define DOC_ "the top level pygame package"
 #define DOC_ISCE "IS_CE = 1\nexists if current pygame is pygame-ce"
 #define DOC_INIT "init() -> (numpass, numfail)\ninitialize all imported pygame modules"
diff --git a/src_c/doc/rect_doc.h b/src_c/doc/rect_doc.h
@@ -1,4 +1,4 @@
-/* Auto generated file: with makeref.py .  Docs go in docs/reST/ref/ . */
+/* Auto generated file: with make_docs.py .  Docs go in docs/reST/ref/ . */
 #define DOC_RECT "Rect(left, top, width, height) -> Rect\nRect((left, top), (width, height)) -> Rect\nRect(object) -> Rect\nRect() -> Rect\nFRect(left, top, width, height) -> FRect\nFRect((left, top), (width, height)) -> FRect\nFRect(object) -> FRect\nFRect() -> FRect\npygame object for storing rectangular coordinates"
 #define DOC_RECT_COPY "copy() -> Rect\ncopy the rectangle"
 #define DOC_RECT_MOVE "move(x, y, /) -> Rect\nmoves the rectangle"
diff --git a/src_c/doc/scrap_doc.h b/src_c/doc/scrap_doc.h
@@ -1,4 +1,4 @@
-/* Auto generated file: with makeref.py .  Docs go in docs/reST/ref/ . */
+/* Auto generated file: with make_docs.py .  Docs go in docs/reST/ref/ . */
 #define DOC_SCRAP "pygame module for clipboard support."
 #define DOC_SCRAP_PUTTEXT "put_text(text, /) -> None\nPlaces text into the clipboard."
 #define DOC_SCRAP_GETTEXT "get_text() -> str\nGets text from the clipboard."
diff --git a/src_c/doc/sdl2_controller_doc.h b/src_c/doc/sdl2_controller_doc.h
@@ -1,4 +1,4 @@
-/* Auto generated file: with makeref.py .  Docs go in docs/reST/ref/ . */
+/* Auto generated file: with make_docs.py .  Docs go in docs/reST/ref/ . */
 #define DOC_SDL2_CONTROLLER "Pygame module to work with controllers."
 #define DOC_SDL2_CONTROLLER_INIT "init() -> None\ninitialize the controller module"
 #define DOC_SDL2_CONTROLLER_QUIT "quit() -> None\nUninitialize the controller module."
diff --git a/src_c/doc/sdl2_video_doc.h b/src_c/doc/sdl2_video_doc.h
@@ -1,4 +1,4 @@
-/* Auto generated file: with makeref.py .  Docs go in docs/reST/ref/ . */
+/* Auto generated file: with make_docs.py .  Docs go in docs/reST/ref/ . */
 #define DOC_SDL2VIDEO "Experimental pygame module for porting new SDL video systems"
 #define DOC_SDL2_VIDEO_MESSAGEBOX "messagebox(title, message, window=None, info=False, warn=False, buttons=('OK',), return_button=0, escape_button=0)\nCreate a native GUI message box"
 #define DOC_SDL2_VIDEO_RENDERERDRIVERINFO "pygame object encapsulating Renderer driver information"
diff --git a/src_c/doc/sndarray_doc.h b/src_c/doc/sndarray_doc.h
@@ -1,4 +1,4 @@
-/* Auto generated file: with makeref.py .  Docs go in docs/reST/ref/ . */
+/* Auto generated file: with make_docs.py .  Docs go in docs/reST/ref/ . */
 #define DOC_SNDARRAY "pygame module for accessing sound sample data"
 #define DOC_SNDARRAY_ARRAY "array(Sound) -> array\ncopy Sound samples into an array"
 #define DOC_SNDARRAY_SAMPLES "samples(Sound) -> array\nreference Sound samples into an array"
diff --git a/src_c/doc/sprite_doc.h b/src_c/doc/sprite_doc.h
diff --git a/src_c/doc/surface_doc.h b/src_c/doc/surface_doc.h
diff --git a/src_c/doc/surfarray_doc.h b/src_c/doc/surfarray_doc.h
diff --git a/src_c/doc/system_doc.h b/src_c/doc/system_doc.h
diff --git a/src_c/doc/tests_doc.h b/src_c/doc/tests_doc.h
diff --git a/src_c/doc/time_doc.h b/src_c/doc/time_doc.h
diff --git a/src_c/doc/touch_doc.h b/src_c/doc/touch_doc.h
diff --git a/src_c/doc/transform_doc.h b/src_c/doc/transform_doc.h
diff --git a/src_c/doc/window_doc.h b/src_c/doc/window_doc.h
