diff --git a/docs/index.rst b/docs/index.rst index af92be8..6aa6589 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -10,7 +10,9 @@ Welcome to pygromacs's documentation! Contents: .. toctree:: - :maxdepth: 2 + :maxdepth: 1 + + toolbox-project modules/pygromacs diff --git a/docs/toolbox-project.rst b/docs/toolbox-project.rst new file mode 100644 index 0000000..56331a2 --- /dev/null +++ b/docs/toolbox-project.rst @@ -0,0 +1,21 @@ +Software Development Toolbox Project +==================================== +This program was (partly) written for the Software Development Toolbox +course given by PDC at KTH, Fall of 2014. + + +Project Abstract +---------------- +The motivation of this project was partly to switch `pygromacs` to a test +driven development model, and partly to add documentation using Sphinx +and `Read the Docs`. + + +The implementation of unit tests +-------------------------------- +[ ] test +[x] tset + + +Documentation using Sphinx +--------------------------