Documetation with sphinx and readthedocs

Maintainer:Dennis Atabay, <dat@wattsight.com> Organization:Wattsight Version: Date:Feb 14, 2019 Copyright:This documentation is licensed under a Creative Commons Attribution 4.0 International license.

Contents

This documentation contains the following pages:

• Getting Started with Sphinx
• Create your documentation
• Include docstrings from your code
• Using ReadtheDocs
• Restructered text syntax example
• exmplpckg package
• Javadoc
• To Do

Features

• simple linear function fitting

Get Started

1. Clone this repository to a directory of your choice.
2. If you actually want to use the package, copy the main folder to a directory which is already in python’s search path or add the it to python’s search path (sys.path) (how to)
3. Use it or just have a look at the documentation

Dependencies

• numpy for mathematical operations
• matplotlib for making plots