- __init__.py added to all folders - preparing docs - .gitignore updated - .vscode/settings.json updated - mypy.ini updated - pyproject.toml updated - plansandideas/Coding optimization plan.md added - plansandideas/REORGANIZATION.md added - scripts/lint.py added - scripts/setup_dev.py added - requirements-dev.txt added - and more.
30 lines
554 B
ReStructuredText
30 lines
554 B
ReStructuredText
Welcome to Sandpypi Documentation
|
|
===============================
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
:caption: Contents:
|
|
|
|
guides/getting_started
|
|
guides/user_guide
|
|
architecture/overview
|
|
api/modules
|
|
|
|
Development Standards
|
|
------------------
|
|
|
|
This project follows these development standards:
|
|
|
|
* Black code formatting (88 characters line length)
|
|
* Type hints for Python functions
|
|
* Google style docstrings
|
|
* Particle simulation physics
|
|
* Optimized rendering with Pygame
|
|
|
|
Quick Links
|
|
----------
|
|
|
|
* :ref:`genindex`
|
|
* :ref:`modindex`
|
|
* :ref:`search`
|