Tedee API documentation

Overview

This repository contains a documentation of the Tedee's API. It aims to help users to integrate with the API by providing guides and code samples.

You can find a compiled version of this documentation here.

Visit our website tedee.com.

Contribution

If you think that there are some areas that should be improved or extended please let us know by creating an Issue. However, we also highly encourage you to contribute to this repo, wheather you want to add some description, guide or provide a sample code.

Documentation specification

The documentation is:

• Written in RST markup
• Generated using Sphinx
• Hosted on ReadTheDocs

How to start

Prepare the infrastructure

To start working on this documentation you will have to install required components. It's well described in ReadTheDocs documentation.

However, here's a quick list of what needs to be done:

• Install Python

  Note

  In the Python installation wizard check the "Add Python to environment variables" option

• Install Sphinx

  pip install sphinx

Prepare your environment

We find the Visual Studio Code to be a great IDE to work on this documentation and we configure some automation for it. Since it's written in RST markup, we recommend to install RST Preview extension to highlight the syntax. It also allows you to immediately preview the document in the IDE using ctrl+shiht+v combination or ctrl+k v to open preview to the side.

Regardles of IDE used, please do following:

1. Clone the repository

2. Install all required dependencies from \docs\requirements.txt file.

   pip install -r requirements.txt

Build and test

Once you install all the required components, setup the environment and clone the repo, you're ready to make some changes. As it was mentioned earlier you can preview your changes in the IDE. However, to get the full documentaion running locally, you'll have to generate it.

To build the documentation:

1. If you use Visual Studio Code run the build task (ctrl+shiht+b)

2. OR if you use terminal then go to docs directory and executing this command

   .\make.bat html

3. After a while you should get the _build folder created where you can find there html catalog with index.html file inside. Open it.

Sometimes you may notice that after building, the files won't get updated. In such case we recommand to run make clean command or just remove _build catalog and try again.

Pushing changes

Please make your changes in feature branches starting from master branch, using naming convention presented below:

• use only lower case
• do not use whitespaces
• do not use any special characters except: -/
• feature/[feature-description] - to implement new features, eg. feature/authenticate-module
• fix/[bug-description] - to fix bugs, eg. bug/incorect-link

Once the changes are done and tested you are ready to create a pull request.