Documentation - introduction

- update the copyright date,

- add an introduction to the documentation.
master
James Cameron 6 years ago
parent 73df533b06
commit 351143a857
  1. 2
      doc/conf.py
  2. 21
      doc/index.rst

@ -67,7 +67,7 @@ master_doc = 'index'
# General information about the project.
project = u'Sugar Toolkit GTK3'
copyright = u'2016, Sugar Labs'
copyright = u'2017, Sugar Labs'
author = u'Sugar Labs'
# The version info for the project you're documenting, acts as replacement for

@ -1,8 +1,21 @@
Welcome to Sugar Toolkit GTK3's documentation!
==============================================
Sugar Toolkit GTK3
==================
Sugar Toolkit GTK3, or `sugar3`, is a toolkit for writing Sugar
activities in Python:
* write a `setup.py` which calls :class:`~sugar3.activity.bundlebuilder`,
* write an `activity/activity.info` file with metadata, see :class:`~sugar3.bundle`,
* write a class derived from :class:`~sugar3.activity.activity.Activity`,
* use the :class:`~sugar3.graphics` module classes to build a user interface.
Optional modules include:
Sugar Toolkit GTK3 (also called `sugar3`) is the toolkit for writing Sugar
activities in Python.
* use the :class:`~sugar3.profile` module to fetch user profile information,
* use the :class:`~sugar3.presence` module classes to implement sharing,
* use the :class:`~sugar3.logger` module for debug logging,
* use the :class:`~sugar3.network` module for downloading data,
* use the :class:`~sugar3.speech` module for speech synthesis.
Indices and tables
==================

Loading…
Cancel
Save