Developing your project

LetThereBe will set up your project with some basic tests and documentation and link it to the tools needed to run and build these for you, however as your project grows you will need to develop these further. On this page we provide links to some guides to help you do this.

Testing

• Testing Your Code from The Hitchiker’s Guide to Python: general guidance on writing tests and python-specific examples
• Automated testing from Learn Python the Hard Way
• pytest framework documentation for testing python code

Documentation

• A beginner’s guide to writing documentation from Write The Docs
• ReadTheDocs documentation
• Quick reStructured Text: guide on rst (reStructured Text) syntax. This is the default markup language used by sphinx for documentation.