diff --git a/docs/README.md b/docs/README.md index 349849b658..337938d68e 100644 --- a/docs/README.md +++ b/docs/README.md @@ -9,9 +9,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 -m buildconfig docs` +- Run `python dev.py docs` - 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) @@ -30,7 +29,7 @@ is useful when editing the theme CSS. --- **INSTEAD USE** --- -There is also `python -m buildconfig docs full_generation` for regenerating +There is also `python dev.py docs --full` for regenerating everything regardless of whether Sphinx thinks it should be regenerated. This is useful when editing the theme CSS. diff --git a/setup.py b/setup.py index 47648be978..cbad740727 100644 --- a/setup.py +++ b/setup.py @@ -807,11 +807,9 @@ def run(self): runs Sphinx to build the docs. ''' import subprocess - command_line = [ - sys.executable, "-m", "buildconfig", "docs" - ] + command_line = [sys.executable, "dev.py", "docs"] if self.fullgeneration: - command_line.append('full_generation') + command_line.append('--full') print("WARNING: This command is deprecated and will be removed in the future.") print(f"Please use the following replacement: `{' '.join(command_line)}`\n") @@ -834,9 +832,7 @@ def run(self): runs mypy to build the docs. ''' import subprocess - command_line = [ - sys.executable, os.path.join("buildconfig", "stubs", "stubcheck.py") - ] + command_line = [sys.executable, "dev.py", "stubs"] print("WARNING: This command is deprecated and will be removed in the future.") print(f"Please use the following replacement: `{' '.join(command_line)}`\n") result = subprocess.run(command_line)