| 1 | .. Plat/al documentation master file, created by |
| 2 | sphinx-quickstart on Fri Mar 29 00:21:10 2013. |
| 3 | You can adapt this file completely to your liking, but it should at least |
| 4 | contain the root `toctree` directive. |
| 5 | |
| 6 | Plat/al 2 |
| 7 | ========= |
| 8 | |
| 9 | Plat/al 2 is the second version of the plat/al (platform for alumni) developed by Polytechnique.org. |
| 10 | |
| 11 | It relies on `the Django framework <http://www.djangoproject.com>`_. |
| 12 | |
| 13 | |
| 14 | This documentation mostly focuses on developer setup, conventions, code architecture. |
| 15 | |
| 16 | Getting started |
| 17 | --------------- |
| 18 | |
| 19 | If you're new to the project, the following documents should help understanding and contributing: |
| 20 | |
| 21 | - :doc:`setup`: How to setup your development environment |
| 22 | - :doc:`coding_rules`: Coding style in use in the project |
| 23 | - :doc:`architecture`: General architecture and code layout |
| 24 | - :doc:`tools`: Common tools used during development |
| 25 | |
| 26 | |
| 27 | Design docs |
| 28 | ----------- |
| 29 | |
| 30 | Those documents describe the design and thoughts about various core parts of plat/al: |
| 31 | |
| 32 | - :doc:`events`: Managing events, registrations, prices |
| 33 | |
| 34 | |
| 35 | Contents |
| 36 | -------- |
| 37 | |
| 38 | .. toctree:: |
| 39 | :maxdepth: 2 |
| 40 | |
| 41 | setup |
| 42 | coding_rules |
| 43 | architecture |
| 44 | tools |
| 45 | |
| 46 | events |
| 47 | |
| 48 | |
| 49 | Indices and tables |
| 50 | ================== |
| 51 | |
| 52 | * :ref:`genindex` |
| 53 | * :ref:`modindex` |
| 54 | * :ref:`search` |
| 55 | |