generic/docs/index.rst

Generic programming library for Python
======================================

Generic is trying to provide a Python programmer with primitives for creating
reusable software components by employing advanced techniques of OOP and other
programming paradigms.

This documentation suits both needs in a tutorial and an API reference for
generic:

.. toctree::
   :maxdepth: 3
   :hidden:
   
   multidispatching
   event_system
   registry

Installation
------------

You can get generic by issuing *easy_install*::

  % easy_install generic

or *pip* command::

  % pip install generic

In case you find a bug or have a feature request, please file a ticket at
`GitHub Issues`_.

.. _GitHub Issues: https://github.com/gaphor/generic/issues

Development process
-------------------

Development takes place at `GitHub`_, you can clone source code repository with the
following command::

  % git clone git://github.com/gaphor/generic.git

In case submitting patch or GitHub pull request please ensure you have
corresponding tests for your bugfix or new functionality.

.. _GitHub: https://github.com/gaphor/generic
fix readme and index docs 2011-12-05 01:12:55 +04:00			`Generic programming library for Python`
			`======================================`
docs on multifunctions 2011-12-03 23:55:45 +04:00
fix readme and index docs 2011-12-05 01:12:55 +04:00			`Generic is trying to provide a Python programmer with primitives for creating`
			`reusable software components by employing advanced techniques of OOP and other`
docs on multifunctions 2011-12-03 23:55:45 +04:00			`programming paradigms.`

			`This documentation suits both needs in a tutorial and an API reference for`
			`generic:`

			`.. toctree::`
API reference for generic.multidispatch 2011-12-04 03:14:52 +04:00			`:maxdepth: 3`
Remove ToC from main page It's in the side bar. 2022-12-21 23:08:15 +03:00			`:hidden:`

docs on multifunctions 2011-12-03 23:55:45 +04:00			`multidispatching`
			`event_system`
			`registry`
fix readme and index docs 2011-12-05 01:12:55 +04:00
docs on multifunctions 2011-12-03 23:55:45 +04:00			`Installation`
			`------------`

			`You can get generic by issuing easy_install::`

			`% easy_install generic`

			`or pip command::`

			`% pip install generic`

			`In case you find a bug or have a feature request, please file a ticket at`
			`GitHub Issues`_.

Update docs 2019-11-17 00:13:56 +03:00			`.. _GitHub Issues: https://github.com/gaphor/generic/issues`
docs on multifunctions 2011-12-03 23:55:45 +04:00
			`Development process`
			`-------------------`

			Development takes place at `GitHub`_, you can clone source code repository with the
			`following command::`

Update docs 2019-11-17 00:13:56 +03:00			`% git clone git://github.com/gaphor/generic.git`
docs on multifunctions 2011-12-03 23:55:45 +04:00
			`In case submitting patch or GitHub pull request please ensure you have`
			`corresponding tests for your bugfix or new functionality.`

Update docs 2019-11-17 00:13:56 +03:00			`.. _GitHub: https://github.com/gaphor/generic`