CS101 Project (2015): Numerical Integration project solution
============================================================
This documentation is an example of an *automatically* generated documentation for a Python programming project.
Its main purpose is to be a solution for the CS programming project, given at `MEC `_ in April 2015.
The most important page is ``_, which documents completely the `integrals` module (main aspect of that project).
.. note::
This documentation was initially written as a solution for a programming project that `I (Lilian Besson) `_ gave to my students in April 2015.
It can be interesting to anyone so I published it under an open-source license.
Please feel free to use this documentation and `this project `_, and do not hesitate to `contact me if needed `_.
-----------------------------------------------------------------------------
About the project
-----------------
- Common instruction paper: `CS101_Programming_Projects__What_to_do__and_how_to_do_it.pdf `_.
- Project paper: `CS101_Programming_Project_6__Numerical_Integration.pdf `_.
- The source code can be found here: `mec-cs101-integrals/src `_ (`integrals.py `_ and `tests.py `_).
- More information about the documentation are here: `readthedocs.org/projects/mec-cs101-integrals `_.
.. note:: How was this documentation created?
In one sentence: I used `bitbucket.org `_ to host the Python programs and text files for the documentation, and `readthedocs.org `_ takes care of automatically reading the files and (re-)generating this website, whenever something changes in a ``.py`` or a ``.txt`` file.
More information about `readthedocs `_ can be found here ``_.
-----------------------------------------------------------------------------
Contents:
---------
.. toctree::
:maxdepth: 5
Readme file
Install file
integrals
tests
License file
Todo file
Authors file
-----------------------------------------------------------------------------
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
-----------------------------------------------------------------------------
Copyright
=========
© `Lilian Besson `_, April 2015.