Skip to content

Update docs #1826

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jun 25, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions CONTRIBUTING.rst
Original file line number Diff line number Diff line change
Expand Up @@ -140,6 +140,8 @@ it will automatically regenerate, and browser tabs will automatically refresh to
If you suspect the automatic rebuilds are failing to detect changes, you can
run a simpler one-time build using the following instructions.

.. _how-to-compile:

One-time build
~~~~~~~~~~~~~~

Expand Down
3 changes: 0 additions & 3 deletions doc/contributing_guide/how_to_build.rst

This file was deleted.

22 changes: 3 additions & 19 deletions doc/contributing_guide/index.rst
Original file line number Diff line number Diff line change
@@ -1,29 +1,14 @@
.. _cg_index:

Arcade Contributing Guide
=========================

The contributing guide is for people who want to propose changes,
implement features, or report bugs in Arcade itself.

For information on how to use arcade to build your own projects, please see
:ref:`pg_index`.


.. _cg_index_quickstart:

Contributing Quickstart
^^^^^^^^^^^^^^^^^^^^^^^
For a quick overview, please see
`CONTRIBUTING.md on GitHub <https://github.com/pythonarcade/arcade/blob/development/CONTRIBUTING.md>`_.

.. include:: ../../CONTRIBUTING.rst

.. _cg_index_contents:

Contributing Guide Contents
^^^^^^^^^^^^^^^^^^^^^^^^^^^
---------------------------

The sections linked below will provide more in-depth coverage of various topics
The sections linked below provide more in-depth coverage of various topics
contributing to arcade, including links to outside resources on development tools
and practices.

Expand All @@ -32,6 +17,5 @@ and practices.

directory_structure
how_to_contribute
how_to_build
how_to_submit_changes
release_checklist
1 change: 0 additions & 1 deletion doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -116,7 +116,6 @@ The Python Arcade Library
contributing_guide/index
contributing_guide/directory_structure
contributing_guide/how_to_contribute
contributing_guide/how_to_build
contributing_guide/how_to_submit_changes
contributing_guide/release_checklist

Expand Down
8 changes: 4 additions & 4 deletions make.py
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@

For help, see the following:

* CONTRIBUTING.md
* CONTRIBUTING.rst
* The output of python make.py --help
"""
import os
Expand Down Expand Up @@ -76,7 +76,7 @@ def _resolve(p: PathLike, strict: bool = False) -> Path:
not_found = [binary for binary in binaries if which(binary) is None]
if not_found:
print("Command-line tools not found: " + ', '.join(not_found))
print("Did you forget to install them with `pip`? See CONTRIBUTING.md file for instructions.")
print("Did you forget to install them with `pip`? See CONTRIBUTING.rst file for instructions.")
exit(1)
for library in libraries:
def find(library):
Expand All @@ -87,7 +87,7 @@ def find(library):
not_found = [library for library in libraries if not find(library)]
if not_found:
print("Python dependencies not found: " + ', '.join(not_found))
print("Did you forget to install them with `pip`? See CONTRIBUTING.md file for instructions.")
print("Did you forget to install them with `pip`? See CONTRIBUTING.rst file for instructions.")
exit(1)


Expand Down Expand Up @@ -484,7 +484,7 @@ def whichshell():

if shell_name in SHELLS_WITH_AUTOCOMPLETE:
print("This shell is known to support tab-completion!")
print("See CONTRIBUTING.md for more information on how to enable it.")
print("See CONTRIBUTING.rst for more information on how to enable it.")


if __name__ == "__main__":
Expand Down
12 changes: 6 additions & 6 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,8 @@ classifiers = [
]
dependencies = [
"pyglet>=2.0.8,<2.1",
"pillow~=9.4.0",
"pymunk~=6.4.0",
"pillow~=9.5.0",
"pymunk~=6.5.0",
"pytiled-parser~=2.2.3"
]
dynamic = ["version"]
Expand All @@ -45,16 +45,16 @@ dev = [
"coveralls",
"pytest-mock",
"pytest-cov",
"pygments==2.14.0",
"pygments==2.15.1",
"docutils==0.19",
"furo",
"pyright",
"pyyaml==6.0",
"sphinx==6.2.1",
"sphinx==7.0.1",
"sphinx-autobuild==2021.3.14",
"sphinx-copybutton==0.5.1",
"sphinx-copybutton==0.5.2",
# Intentionally kept at 2.3 until this bugfix is published: https://github.com/jdillard/sphinx-sitemap/pull/62
"sphinx-sitemap==2.3.0",
"sphinx-sitemap==2.5.0",
"typer[all]==0.7.0",
"wheel",
]
Expand Down