Introduction

This page aims at giving a broad presentation of the tool and of the contents of this documentation, so that you know where to start if you are a beginner or where to look if you need info on a specific feature.

About the documentation

This documentation is continuously written, corrected, edited and revamped by members of the .Profile team and community. It is edited via text files in the reStructuredText markup language and then compiled into a static website/offline document using the open source Sphinx and ReadTheDocs tools.

Note

You can contribute to .Profiles’s documentation by opening issues through YouTrack or sending patches via pull requests on its GitHub source repository.

Organisation of the documentation

This documentation is organised in five sections, the way it is split up should be relatively intuitive:

• The General section contains this introduction as well as general information on the tool It also contains the Frequently asked questions.
• The Getting Started section is the the main entry point of this documentation, as it contains all the necessary information on using the tool. It starts with the Step by step tutorial which should be the entry point for all new users.
• Finally, the Class API reference is the documentation of the .Profile API. It is generated automatically from a files in the main repository, and the generated files of the documentation are therefore not meant to be modified.