sandpypi/docs/index.rst

30 lines
582 B
ReStructuredText

Welcome to Sandpypi Documentation
===============================
.. toctree::
:maxdepth: 2
:caption: Contents:
guides/getting_started
guides/user_guide
architecture/overview
api/modules
source/modules
source/modindex
Development Standards
------------------
This project follows these development standards:
* Black/flake8 code formatting (79 characters line length)
* Type hints for Python functions
* Google style docstrings
* Particle simulation physics
* Optimized rendering with Pygame
Quick Links
----------
* :ref:`modindex`
* :ref:`search`